org.odpi.openmetadata.frameworks.connectors.ffdc

Class ConnectorCheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException

All Implemented Interfaces:

Serializable

public class ConnectorCheckedException
extends OCFCheckedExceptionBase

ConnectorCheckedException provides a checked exception for reporting errors found when using OCF connectors. 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 OCFErrorCode can be used with this exception to populate it with standard messages. Otherwise messages defined uniquely for a ConnectorProvider/Connector implementation can be used. The aim is to be able to uniquely identify the cause and remedy for the error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectorCheckedException(ConnectorCheckedException template) This is the copy/clone constructor used for creating an exception.
ConnectorCheckedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating a ConnectorCheckedException.
ConnectorCheckedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating a ConnectorCheckedException in response to a previous exception.

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

ConnectorCheckedException

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

This is the typical constructor used for creating a ConnectorCheckedException.

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

ConnectorCheckedException

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

This is the constructor used for creating a ConnectorCheckedException in response to a previous exception.

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 - the error that resulted in this exception.

ConnectorCheckedException

public ConnectorCheckedException(ConnectorCheckedException template)

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

Parameters:

template - object to copy