org.odpi.openmetadata.frameworks.connectors.ffdc

Class OCFCheckedExceptionBase

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConnectionCheckedException, ConnectorCheckedException, InvalidParameterException, PropertyServerException, UserNotAuthorizedException

public abstract class OCFCheckedExceptionBase
extends Exception

OCFCheckedExceptionBase 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
OCFCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating an OCFCheckedException.
OCFCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Map<String,Object> relatedProperties) This is the typical constructor used for creating an OCFCheckedException.
OCFCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught.
OCFCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, Map<String,Object> relatedProperties) This is the constructor used for creating an OCFCheckedException when an unexpected error has been caught.
OCFCheckedExceptionBase(OCFCheckedExceptionBase template) This is the copy/clone constructor used for creating an OCFCheckedException.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getErrorMessage() A formatted short description of the cause of the condition that resulted in this exception.
Map<String,Object>	getRelatedProperties() Return any additional properties that were added to the exception to aid diagnosis.
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.
int	hashCode() Provide a common implementation of hashCode for all OCF Exception objects.
String	toString() Standard toString method.

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

OCFCheckedExceptionBase

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

This is the typical constructor used for creating an OCFCheckedException.

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

OCFCheckedExceptionBase

public OCFCheckedExceptionBase(int httpCode,
                               String className,
                               String actionDescription,
                               String errorMessage,
                               String systemAction,
                               String userAction,
                               Map<String,Object> relatedProperties)

This is the typical constructor used for creating an OCFCheckedException.

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

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFCheckedExceptionBase

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

This is the constructor used for creating an OCFCheckedException 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

OCFCheckedExceptionBase

public OCFCheckedExceptionBase(int httpCode,
                               String className,
                               String actionDescription,
                               String errorMessage,
                               String systemAction,
                               String userAction,
                               Throwable caughtError,
                               Map<String,Object> relatedProperties)

This is the constructor used for creating an OCFCheckedException 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

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFCheckedExceptionBase

public OCFCheckedExceptionBase(OCFCheckedExceptionBase template)

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

Parameters:

template - object to copy

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

getRelatedProperties

public Map<String,Object> getRelatedProperties()

Return any additional properties that were added to the exception to aid diagnosis.

Returns:

property map

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Provide a common implementation of hashCode for all OCF Exception objects.

Overrides:

hashCode in class Object

Returns:

integer hash code based on the values in the attributes

toString

public String toString()

Standard toString method.

Overrides:

toString in class Throwable

Returns:

print out of variables in a JSON-style