Package org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc.exception

Class ConfigException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc.exception.ConfigException
All Implemented Interfaces:
Serializable
public class ConfigException extends org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
The ConfigException is thrown by the connector when its configuration is inadequate.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileNameSource, String fileName)
    This is the constructor used for creating an exception that resulted from a previous error.
    ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileNameSource, String fileName, Map<String,Object> relatedProperties)
    This is the constructor used for creating an exception that resulted from a previous error.
    ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileNameSource, String fileName)
    This is the typical constructor used for creating an exception.
    ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileNameSource, String fileName, Map<String,Object> relatedProperties)
    This is the typical constructor used for creating an exception.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    String
    getFileName()
    Return the invalid parameter's name, if known.
    String
    getFileNameSource()
    Return the source of the file name.
    int
    hashCode()
    Return hash code for this object
    String
    toString()
    JSON-style toString

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

    getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName

    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

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ConfigException

      public ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileNameSource, String fileName)
      This is the typical constructor used for creating an exception.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      fileNameSource - how was the file name supplied to the connector
      fileName - name of the invalid parameter if known

    • ConfigException

      public ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String fileNameSource, String fileName, Map<String,Object> relatedProperties)
      This is the typical constructor used for creating an exception.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      fileNameSource - how was the file name supplied to the connector
      fileName - name of the invalid parameter if known
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • ConfigException

      public ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileNameSource, String fileName)
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - the error that resulted in this exception.
      fileNameSource - how was the file name supplied to the connector
      fileName - name of the invalid parameter if known

    • ConfigException

      public ConfigException(org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String fileNameSource, String fileName, Map<String,Object> relatedProperties)
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      messageDefinition - content of message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - the error that resulted in this exception.
      fileNameSource - how was the file name supplied to the connector
      fileName - name of the invalid parameter if known
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

  • Method Details

    • getFileNameSource

      public String getFileNameSource()
      Return the source of the file name.
      Returns:
      string name

    • getFileName

      public String getFileName()
      Return the invalid parameter's name, if known.
      Returns:
      string name

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
      Returns:
      string of property names and values for this enum

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
      Returns:
      int hash code