Enum Class DataFolderConnectorErrorCode

All Implemented Interfaces:
Serializable, Comparable<DataFolderConnectorErrorCode>, Constable, ExceptionMessageSet

public enum DataFolderConnectorErrorCode extends Enum<DataFolderConnectorErrorCode> implements ExceptionMessageSet
The DataFolderConnectorErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Data Folder 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


      public static final DataFolderConnectorErrorCode FOLDER_NOT_SPECIFIED
      DATA-FOLDER-CONNECTOR-400-001 - The folder name is null in the Connection object {0}

      public static final DataFolderConnectorErrorCode FILE_NOT_DIRECTORY
      DATA-FOLDER-CONNECTOR-400-002 - The folder {0} given in Connection object {1} is a file

      public static final DataFolderConnectorErrorCode FOLDER_NOT_READABLE
      DATA-FOLDER-CONNECTOR-400-003 - The folder {0} given in Connection object {1} is not readable

      public static final DataFolderConnectorErrorCode FOLDER_NOT_FOUND
      DATA-FOLDER-CONNECTOR-404-001 - The folder named {0} in the Connection object {1} does not exist

      public static final DataFolderConnectorErrorCode UNEXPECTED_SECURITY_EXCEPTION
      DATA-FOLDER-CONNECTOR-500-001 - The connector received an unexpected security exception when reading the file named {0}; the error message was: {1}

      public static final DataFolderConnectorErrorCode UNEXPECTED_IO_EXCEPTION
      DATA-FOLDER-CONNECTOR-500-002 - The connector received an unexpected IO exception when reading the folder named {0}; the error message was: {1}
  • Method Details

    • values

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

      public static DataFolderConnectorErrorCode 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      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
      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
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      message definition object.
    • toString

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