Enum LineageIntegratorErrorCode
- java.lang.Object
-
- java.lang.Enum<LineageIntegratorErrorCode>
-
- org.odpi.openmetadata.integrationservices.lineage.ffdc.LineageIntegratorErrorCode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<LineageIntegratorErrorCode>
,ExceptionMessageSet
public enum LineageIntegratorErrorCode extends java.lang.Enum<LineageIntegratorErrorCode> implements ExceptionMessageSet
The LineageIntegratorErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Services. It is used in conjunction with all 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 Id - 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
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INVALID_CONNECTOR
NULL_CONTEXT
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ExceptionMessageDefinition
getMessageDefinition()
Retrieve a message definition object for an exception.ExceptionMessageDefinition
getMessageDefinition(java.lang.String... params)
Retrieve a message definition object for an exception.java.lang.String
toString()
JSON-style toStringstatic LineageIntegratorErrorCode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static LineageIntegratorErrorCode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INVALID_CONNECTOR
public static final LineageIntegratorErrorCode INVALID_CONNECTOR
-
NULL_CONTEXT
public static final LineageIntegratorErrorCode NULL_CONTEXT
-
-
Method Detail
-
values
public static LineageIntegratorErrorCode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (LineageIntegratorErrorCode c : LineageIntegratorErrorCode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LineageIntegratorErrorCode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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 interfaceExceptionMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
public ExceptionMessageDefinition getMessageDefinition(java.lang.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 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
public java.lang.String toString()
JSON-style toString- Overrides:
toString
in classjava.lang.Enum<LineageIntegratorErrorCode>
- Returns:
- string of property names and values for this enum
-
-