Package org.odpi.openmetadata.repositoryservices.ffdc.exception

Class OMRSConfigErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSRuntimeException

org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSConfigErrorException

All Implemented Interfaces:

Serializable

public class OMRSConfigErrorException
extends OMRSRuntimeException

OMRSConfigErrorException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS) components that indicate a configuration error. It is used in conjunction with the OMRSErrorCode to provide first failure data capture for these errors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OMRSConfigErrorException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction)	Deprecated.
OMRSConfigErrorException(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.
OMRSConfigErrorException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError)	Deprecated.
OMRSConfigErrorException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)	This is the typical constructor used for creating an exception.
OMRSConfigErrorException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError)	This is the constructor used for creating an exception when an unexpected error has been caught.
OMRSConfigErrorException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties)	This is the constructor used for creating an exception when an unexpected error has been caught.
OMRSConfigErrorException(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.repositoryservices.ffdc.exception.OMRSRuntimeException

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 Detail

OMRSConfigErrorException

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

OMRSConfigErrorException

public OMRSConfigErrorException(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.

OMRSConfigErrorException

public OMRSConfigErrorException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription,
                                Throwable 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

OMRSConfigErrorException

public OMRSConfigErrorException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription,
                                Throwable 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.

OMRSConfigErrorException

public OMRSConfigErrorException(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.

OMRSConfigErrorException

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

Deprecated.

This is the typical constructor used for creating an OMRSConfigErrorException.

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

OMRSConfigErrorException

@Deprecated
public OMRSConfigErrorException(int httpCode,
                                String className,
                                String actionDescription,
                                String errorMessage,
                                String systemAction,
                                String userAction,
                                Throwable caughtError)

Deprecated.

This is the constructor used for creating a OMRSConfigErrorException when an unexpected exception 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