Class OMAGCheckedExceptionBase

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AssetCatalogException, NewInstanceException, SubjectAreaCheckedException

public abstract class OMAGCheckedExceptionBase extends OCFCheckedExceptionBase
OMAGCheckedExceptionBase provides a checked exception for reporting errors found when using the Open Metadata and Governance (OMAG) services.
See Also:
  • Constructor Details

    • OMAGCheckedExceptionBase

      public OMAGCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)
      This is the typical constructor used for creating an OMAGCheckedExceptionBase.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
    • OMAGCheckedExceptionBase

      public OMAGCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties)
      This is the typical constructor used for creating an OMAGCheckedExceptionBase. 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.
    • OMAGCheckedExceptionBase

      public OMAGCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError)
      This is the constructor used for creating an OMAGCheckedExceptionBase 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
    • OMAGCheckedExceptionBase

      public OMAGCheckedExceptionBase(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties)
      This is the constructor used for creating an OMAGCheckedExceptionBase 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.
    • OMAGCheckedExceptionBase

      public OMAGCheckedExceptionBase(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.
    • OMAGCheckedExceptionBase

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