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

Enum Class BasicFilesIntegrationConnectorsErrorCode

java.lang.Object
java.lang.Enum<BasicFilesIntegrationConnectorsErrorCode>
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc.BasicFilesIntegrationConnectorsErrorCode
All Implemented Interfaces:
Serializable, Comparable<BasicFilesIntegrationConnectorsErrorCode>, Constable, ExceptionMessageSet
public enum BasicFilesIntegrationConnectorsErrorCode extends Enum<BasicFilesIntegrationConnectorsErrorCode> implements ExceptionMessageSet
The BasicFilesIntegrationConnectorsErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Basic File Connector. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. The 5 fields in the enum are:
  • HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
    • 500 - internal error
    • 400 - invalid parameters
    • 404 - not found
    • 409 - data conflict errors - eg item already defined
  • Error Message Identifier - to uniquely identify the message
  • Error Message Text - includes placeholder to allow additional values to be captured
  • SystemAction - describes the result of the error
  • UserAction - describes how a consumer should correct the error

  • Enum Constant Details

    • FILES_LOCATION_NOT_SPECIFIED

      public static final BasicFilesIntegrationConnectorsErrorCode FILES_LOCATION_NOT_SPECIFIED
      BASIC-FILES-INTEGRATION-CONNECTORS-400-001 - The name of the directory (folder) identifying where the files to be catalogued are located is null in the Connection object {0}

    • FILES_LOCATION_NOT_DIRECTORY

      public static final BasicFilesIntegrationConnectorsErrorCode FILES_LOCATION_NOT_DIRECTORY
      BASIC-FILES-INTEGRATION-CONNECTORS-400-002 - The file location {0} is not a directory

    • FILES_LOCATION_NOT_READABLE

      public static final BasicFilesIntegrationConnectorsErrorCode FILES_LOCATION_NOT_READABLE
      BASIC-FILES-INTEGRATION-CONNECTORS-400-003 - The directory (folder) {0} is not readable

    • UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_PATH_NAME

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_PATH_NAME
      BASIC-FILES-INTEGRATION-CONNECTORS-400-004 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset for directory {3} (absolute path {4}). The error message was {5}

    • UNEXPECTED_EXC_DATA_FILE_UPDATE

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_EXC_DATA_FILE_UPDATE
      BASIC-FILES-INTEGRATION-CONNECTORS-400-005 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the DataFile in the metadata repositories for file {2}. The error message was {3}

    • FILES_LOCATION_NOT_FOUND

      public static final BasicFilesIntegrationConnectorsErrorCode FILES_LOCATION_NOT_FOUND
      BASIC-FILES-INTEGRATION-CONNECTORS-404-001 - The directory named {0} does not exist

    • UNEXPECTED_SECURITY_EXCEPTION

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_SECURITY_EXCEPTION
      BASIC-FILES-INTEGRATION-CONNECTORS-500-001 - The connector received an unexpected security exception when reading the file named {0}; the error message was: {1}

    • UNEXPECTED_IO_EXCEPTION

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_IO_EXCEPTION
      BASIC-FILES-INTEGRATION-CONNECTORS-500-002 - The connector received an unexpected IO exception when reading the file named {0}; the error message was: {1}

    • UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_GUID

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_GUID
      BASIC-FILES-INTEGRATION-CONNECTORS-500-003 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset {3}. The error message was {4}

    • UNEXPECTED_EXC_RETRIEVING_CATALOG_TARGETS

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_EXC_RETRIEVING_CATALOG_TARGETS
      BASIC-FILES-INTEGRATION-CONNECTORS-500-004 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the catalog targets for connector {3}. The error message was {4}

    • UNEXPECTED_EXCEPTION

      public static final BasicFilesIntegrationConnectorsErrorCode UNEXPECTED_EXCEPTION
      BASIC-FILES-INTEGRATION-CONNECTORS-500-005 - The connector {0} received an unexpected {1} exception when processing the file named {2} in method {3}; the error message was: {4}

  • Method Details

    • values

      public static BasicFilesIntegrationConnectorsErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BasicFilesIntegrationConnectorsErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public ExceptionMessageDefinition getMessageDefinition()
      Retrieve a message definition object for an exception. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public ExceptionMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<BasicFilesIntegrationConnectorsErrorCode>
      Returns:
      string of property names and values for this enum