org.odpi.openmetadata.adminservices.ffdc.exception

Class OMAGCheckedExceptionBase

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OMAGConfigurationErrorException, OMAGInvalidParameterException, OMAGNotAuthorizedException

public class OMAGCheckedExceptionBase
extends Exception

OMAGCheckedExceptionBase provides a checked exception for reporting errors found when using the OMAG Server. Typically these errors are either configuration or operational errors that can be fixed by an administrator or power user. However, there may be the odd bug that surfaces here. The OMAGErrorCode can be used with this exception to populate it with standard messages.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMAGCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating a OMRSCheckedExceptionBase.
OMAGCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating a OMRSCheckedExceptionBase when an unexpected error has 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	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 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

OMAGCheckedExceptionBase

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

This is the typical constructor used for creating a OMRSCheckedExceptionBase.

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

OMAGCheckedExceptionBase

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

This is the constructor used for creating a OMRSCheckedExceptionBase 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

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

public String getErrorMessage()

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

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