Enum LineageIntegratorAuditCode
- java.lang.Object
-
- java.lang.Enum<LineageIntegratorAuditCode>
-
- org.odpi.openmetadata.integrationservices.lineage.ffdc.LineageIntegratorAuditCode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<LineageIntegratorAuditCode>
,AuditLogMessageSet
public enum LineageIntegratorAuditCode extends java.lang.Enum<LineageIntegratorAuditCode> implements AuditLogMessageSet
The LineageIntegratorAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:- Log Message Id - to uniquely identify the message
- Severity - is this an event, decision, action, error or exception
- Log Message Text - includes placeholder to allow additional values to be captured
- Additional Information - further parameters and data relating to the audit message (optional)
- SystemAction - describes the result of the situation
- UserAction - describes how a user should correct the situation
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONNECTOR_CONTEXT_INITIALIZING
CONTEXT_INITIALIZING
NULL_CONTEXT
OPEN_LINEAGE_FORMAT_ERROR
OPEN_LINEAGE_PUBLISH_ERROR
PERMITTED_SYNCHRONIZATION
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuditLogMessageDefinition
getMessageDefinition()
Retrieve a message definition object for logging.AuditLogMessageDefinition
getMessageDefinition(java.lang.String... params)
Retrieve a message definition object for logging.java.lang.String
toString()
toString() JSON-stylestatic LineageIntegratorAuditCode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static LineageIntegratorAuditCode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CONTEXT_INITIALIZING
public static final LineageIntegratorAuditCode CONTEXT_INITIALIZING
-
CONNECTOR_CONTEXT_INITIALIZING
public static final LineageIntegratorAuditCode CONNECTOR_CONTEXT_INITIALIZING
-
PERMITTED_SYNCHRONIZATION
public static final LineageIntegratorAuditCode PERMITTED_SYNCHRONIZATION
-
NULL_CONTEXT
public static final LineageIntegratorAuditCode NULL_CONTEXT
-
OPEN_LINEAGE_FORMAT_ERROR
public static final LineageIntegratorAuditCode OPEN_LINEAGE_FORMAT_ERROR
-
OPEN_LINEAGE_PUBLISH_ERROR
public static final LineageIntegratorAuditCode OPEN_LINEAGE_PUBLISH_ERROR
-
-
Method Detail
-
values
public static LineageIntegratorAuditCode[] 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 (LineageIntegratorAuditCode c : LineageIntegratorAuditCode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LineageIntegratorAuditCode 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 AuditLogMessageDefinition getMessageDefinition()
Retrieve a message definition object for logging. This method is used when there are no message inserts.- Specified by:
getMessageDefinition
in interfaceAuditLogMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
public AuditLogMessageDefinition getMessageDefinition(java.lang.String... params)
Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.- Specified by:
getMessageDefinition
in interfaceAuditLogMessageSet
- 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()
toString() JSON-style- Overrides:
toString
in classjava.lang.Enum<LineageIntegratorAuditCode>
- Returns:
- string description
-
-