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

Class OMRSCheckedExceptionBase

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSCheckedExceptionBase
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ClassificationErrorException, EntityConflictException, EntityNotDeletedException, EntityNotKnownException, EntityProxyOnlyException, FunctionNotSupportedException, HomeEntityException, HomeRelationshipException, InvalidEntityException, InvalidParameterException, InvalidRelationshipException, InvalidTypeDefException, PagingErrorException, PatchErrorException, PropertyErrorException, RelationshipConflictException, RelationshipNotDeletedException, RelationshipNotKnownException, RepositoryErrorException, StatusNotSupportedException, TypeDefConflictException, TypeDefInUseException, TypeDefKnownException, TypeDefNotKnownException, TypeDefNotSupportedException, TypeErrorException, UserNotAuthorizedException
public abstract class OMRSCheckedExceptionBase extends OCFCheckedExceptionBase
OMRSCheckedExceptionBase provides a checked exception for reporting errors found when using the OMRS. 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 OMRSErrorCode 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:

  • Constructor Details

    • OMRSCheckedExceptionBase

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

    • OMRSCheckedExceptionBase

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

    • OMRSCheckedExceptionBase

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

    • OMRSCheckedExceptionBase

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

    • OMRSCheckedExceptionBase

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

    • OMRSCheckedExceptionBase

      public OMRSCheckedExceptionBase(String errorMessage, OCFCheckedExceptionBase template)
      This is the copy/clone constructor used for creating an exception.
      Parameters:
      errorMessage - associated message
      template - object to copy

    • OMRSCheckedExceptionBase

      @Deprecated public OMRSCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction)
      Deprecated.
      This is the typical constructor used for creating a OMRSCheckedExceptionBase.
      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

    • OMRSCheckedExceptionBase

      @Deprecated public OMRSCheckedExceptionBase(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError)
      Deprecated.
      This is the constructor used for creating a OMRSCheckedExceptionBase 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