org.odpi.openmetadata.frameworks.connectors.ffdc

Class ConnectionCheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException

All Implemented Interfaces:

Serializable

public class ConnectionCheckedException
extends OCFCheckedExceptionBase

ConnectionCheckedException provides a checked exception for reporting errors found in connection objects. Typically these errors are configuration errors that can be fixed by an administrator or power user. The connection object has a complex structure and the aim of this exception, in conjunction with OCFErrorCode, is to identify exactly what is wrong with the contents of the connection object and the consequences of this error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionCheckedException(ConnectionCheckedException template) This is the copy/clone constructor used for creating an exception.
ConnectionCheckedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor for creating a ConnectionCheckedException.
ConnectionCheckedException(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 ConnectionCheckedException in order to add the essential details about the error, where it occurred and how to fix it.

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

ConnectionCheckedException

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

This is the typical constructor for creating a ConnectionCheckedException. 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

ConnectionCheckedException

public ConnectionCheckedException(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 ConnectionCheckedException 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

ConnectionCheckedException

public ConnectionCheckedException(ConnectionCheckedException template)

This is the copy/clone constructor used for creating an exception.

Parameters:

template - object to copy