org.odpi.openmetadata.frameworks.discovery.ffdc

Class DiscoveryEngineException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

org.odpi.openmetadata.frameworks.discovery.ffdc.DiscoveryEngineException

All Implemented Interfaces:

Serializable

public class DiscoveryEngineException
extends OCFCheckedExceptionBase

DiscoveryEngineException indicates there is a problem with a request to a specific discovery engine. The error codes and messages indicate the cause of the problem and guidance on finding a remedy.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DiscoveryEngineException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor for creating the exception.
DiscoveryEngineException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This constructor is used when an unexpected exception has been caught that needs to be wrapped in a DiscoveryEngineException in order to add the essential details about the error, where it occurred and how to fix it.
DiscoveryEngineException(OCFCheckedExceptionBase template) This constructor is used when an unexpected exception has been caught that needs to be translated in a DiscoveryEngineException.

Method Summary

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

equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName, hashCode, toString

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

DiscoveryEngineException

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

This is the typical constructor for creating the exception. It captures the essential details about the error, where it occurred and how to fix it.

Parameters:

httpCode - code to use across a REST interface

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

DiscoveryEngineException

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

This constructor is used when an unexpected exception has been caught that needs to be wrapped in a DiscoveryEngineException in order to add the essential details about the error, where it occurred and how to fix it.

Parameters:

httpCode - code to use across a REST interface

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 - the exception/error that caused this exception to be raised

DiscoveryEngineException

public DiscoveryEngineException(OCFCheckedExceptionBase template)

This constructor is used when an unexpected exception has been caught that needs to be translated in a DiscoveryEngineException.

Parameters:

template - exception to copy