Package 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	Description
CommunityProfileCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction)	Deprecated.
CommunityProfileCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, Map<String,Object> relatedProperties)	This is the constructor used when receiving an exception from a remote server.
CommunityProfileCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Exception caughtError)	Deprecated.
CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)	This is the typical constructor used for creating an exception.
CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError)	This is the constructor used for creating an exception when an unexpected error has been caught.
CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, Map<String,Object> relatedProperties)	This is the constructor used for creating an exception when an unexpected error has been caught.
CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties)	This is the typical constructor used for creating an exception.

Method Summary

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

equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, 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 Details

CommunityProfileCheckedExceptionBase

public CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription)

This is the typical constructor used for creating an exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

CommunityProfileCheckedExceptionBase

public CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Map<String,Object> relatedProperties)

This is the typical constructor used for creating an exception. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

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

CommunityProfileCheckedExceptionBase

public CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Exception caughtError)

This is the constructor used for creating an exception when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

CommunityProfileCheckedExceptionBase

public CommunityProfileCheckedExceptionBase(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Exception caughtError,
 Map<String,Object> relatedProperties)

This is the constructor used for creating an exception when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

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

CommunityProfileCheckedExceptionBase

public CommunityProfileCheckedExceptionBase(int httpCode,
 String className,
 String actionDescription,
 String errorMessage,
 String errorMessageId,
 String[] errorMessageParameters,
 String systemAction,
 String userAction,
 String caughtErrorClassName,
 Map<String,Object> relatedProperties)

This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.

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

errorMessageId - unique identifier for the message

errorMessageParameters - parameters that were inserted in the message

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtErrorClassName - previous error causing this exception

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

CommunityProfileCheckedExceptionBase

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

Deprecated.

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

@Deprecated
public CommunityProfileCheckedExceptionBase(int httpCode,
 String className,
 String actionDescription,
 String errorMessage,
 String systemAction,
 String userAction,
 Exception caughtError)

Deprecated.

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.