Enum Class ODFErrorCode
- All Implemented Interfaces:
Serializable
,Comparable<ODFErrorCode>
,Constable
,ExceptionMessageSet
The ODF error code is used to define first failure data capture (FFDC) for errors that occur when working with
ODF Discovery Services. It is used in conjunction with all ODF Exceptions, both Checked and Runtime (unchecked).
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 user 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 ConstantDescriptionODF-DISCOVERY-SERVICE-400-003 - No embedded discovery services supplied to the discovery pipeline {0}ODF-DISCOVERY-SERVICE-400-002 - No embedded discovery services supplied to the discovery pipeline {0}ODF-DISCOVERY-SERVICE-400-001 - No discovery context supplied to the discovery service {0}ODF-DISCOVERY-SERVICE-500-001 - Unexpected exception in discovery service {0} of type {1} detected by method {2}. -
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 ODFErrorCode
Returns the enum constant of this class with the specified name.static ODFErrorCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NULL_DISCOVERY_CONTEXT
ODF-DISCOVERY-SERVICE-400-001 - No discovery context supplied to the discovery service {0} -
NO_EMBEDDED_DISCOVERY_SERVICES
ODF-DISCOVERY-SERVICE-400-002 - No embedded discovery services supplied to the discovery pipeline {0} -
INVALID_EMBEDDED_DISCOVERY_SERVICE
ODF-DISCOVERY-SERVICE-400-003 - No embedded discovery services supplied to the discovery pipeline {0} -
UNEXPECTED_EXCEPTION
ODF-DISCOVERY-SERVICE-500-001 - Unexpected exception in discovery service {0} of type {1} detected by method {2}. The error message was {3}
-
-
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<ODFErrorCode>
- Returns:
- string of property names and values for this enum
-