org.odpi.openmetadata.accessservices.communityprofile.ffdc.exceptions

Class CommunityProfileCheckedExceptionBase

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

org.odpi.openmetadata.accessservices.communityprofile.ffdc.exceptions.CommunityProfileCheckedExceptionBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NoProfileForUserException

public abstract class CommunityProfileCheckedExceptionBase
extends OCFCheckedExceptionBase

CommunityProfileCheckedExceptionBase provides a checked exception for reporting errors found when using the Community Profile OMAS services. Typically these errors are either configuration or operational errors that can be fixed by an administrator or the developer that wrote the consuming service. However, there may be the odd bug that surfaces here. The CommunityProfileErrorCode can be used with this exception to populate it with standard messages. 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
CommunityProfileCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating an exception.
CommunityProfileCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating an exception that resulted from a previous error.

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

CommunityProfileCheckedExceptionBase

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

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

CommunityProfileCheckedExceptionBase

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

This is the constructor used for creating an exception that resulted from a previous error.

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.