Enum Class BasicFileConnectorErrorCode
java.lang.Object
java.lang.Enum<BasicFileConnectorErrorCode>
org.odpi.openmetadata.adapters.connectors.datastore.basicfile.ffdc.BasicFileConnectorErrorCode
- All Implemented Interfaces:
Serializable
,Comparable<BasicFileConnectorErrorCode>
,Constable
,ExceptionMessageSet
public enum BasicFileConnectorErrorCode
extends Enum<BasicFileConnectorErrorCode>
implements ExceptionMessageSet
The BasicFileConnectorErrorCode 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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionBASIC-FILE-CONNECTOR-400-002 - The file {0} given in Connection object {1} is a directoryBASIC-FILE-CONNECTOR-400-006 - The folder {0} given in Connection object {1} is a fileBASIC-FILE-CONNECTOR-404-002 - The file named {0} in the Connection object {1} does not existBASIC-FILE-CONNECTOR-400-003 - The file {0} given in Connection object {1} is not readableBASIC-FILE-CONNECTOR-400-001 - The file name is null in the Connection object {0}BASIC-FILE-CONNECTOR-404-001 - The folder named {0} in the Connection object {1} does not existBASIC-FILE-CONNECTOR-400-007 - The folder {0} given in Connection object {1} is not readableBASIC-FILE-CONNECTOR-400-005 - The folder name is null in the Connection object {0}BASIC-FILE-CONNECTOR-500-002 - The connector received an unexpected IO exception when reading the file named {0}; the error message was: {1}BASIC-FILE-CONNECTOR-500-001 - The connector received an unexpected security exception when reading the file named {0}; the error message was: {1} -
Method Summary
Modifier and TypeMethodDescriptionRetrieve a message definition object for an exception.getMessageDefinition
(String... params) Retrieve a message definition object for an exception.toString()
JSON-style toStringstatic BasicFileConnectorErrorCode
Returns the enum constant of this class with the specified name.static BasicFileConnectorErrorCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FILE_NOT_SPECIFIED
BASIC-FILE-CONNECTOR-400-001 - The file name is null in the Connection object {0} -
DIRECTORY_SPECIFIED
BASIC-FILE-CONNECTOR-400-002 - The file {0} given in Connection object {1} is a directory -
FILE_NOT_READABLE
BASIC-FILE-CONNECTOR-400-003 - The file {0} given in Connection object {1} is not readable -
FOLDER_NOT_SPECIFIED
BASIC-FILE-CONNECTOR-400-005 - The folder name is null in the Connection object {0} -
FILE_NOT_DIRECTORY
BASIC-FILE-CONNECTOR-400-006 - The folder {0} given in Connection object {1} is a file -
FOLDER_NOT_READABLE
BASIC-FILE-CONNECTOR-400-007 - The folder {0} given in Connection object {1} is not readable -
FOLDER_NOT_FOUND
BASIC-FILE-CONNECTOR-404-001 - The folder named {0} in the Connection object {1} does not exist -
FILE_NOT_FOUND
BASIC-FILE-CONNECTOR-404-002 - The file named {0} in the Connection object {1} does not exist -
UNEXPECTED_SECURITY_EXCEPTION
BASIC-FILE-CONNECTOR-500-001 - The connector received an unexpected security exception when reading the file named {0}; the error message was: {1} -
UNEXPECTED_IO_EXCEPTION
BASIC-FILE-CONNECTOR-500-002 - The connector received an unexpected IO exception when reading the file named {0}; the error message was: {1}
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getMessageDefinition
Retrieve a message definition object for an exception. This method is used when there are no message inserts.- Specified by:
getMessageDefinition
in interfaceExceptionMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
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 interfaceExceptionMessageSet
- 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
JSON-style toString- Overrides:
toString
in classEnum<BasicFileConnectorErrorCode>
- Returns:
- string of property names and values for this enum
-