Package org.odpi.openmetadata.accessservices.dataengine.ffdc

Enum Class DataEngineAuditCode

java.lang.Object

java.lang.Enum<DataEngineAuditCode>

org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineAuditCode

All Implemented Interfaces:

Serializable, Comparable<DataEngineAuditCode>, Constable

public enum DataEngineAuditCode
extends Enum<DataEngineAuditCode>

The DataEngineAuditCode is used to define the message content for the OMRS Audit Log.

The 5 fields in the enum are:

• Log Message Identifier - 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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_INITIALIZING_TOPIC_CONNECTION	OMAS-DATA-ENGINE-0005 The Data Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance
IN_TOPIC_EVENT_SENT	OMAS-DATA-ENGINE-0008 The Data Engine Open Metadata Access Service (OMAS) client has sent an event
PARSE_EVENT_EXCEPTION	OMAS-DATA-ENGINE-0007 The Data Engine Open Metadata Access Service (OMAS) is unable to parse an event
PROCESS_EVENT_EXCEPTION	OMAS-DATA-ENGINE-0006 The Data Engine Open Metadata Access Service (OMAS) is unable to process an event on its in topic
SERVICE_INITIALIZED	OMAS-DATA-ENGINE-0002 The Data Engine Open Metadata Access Service (OMAS) has initialized a new instance for server
SERVICE_INITIALIZING	OMAS-DATA-ENGINE-0001 The Data Engine Open Metadata Access Service (OMAS) is initializing a new server instance
SERVICE_INSTANCE_FAILURE	OMAS-DATA-ENGINE-0004 The Data Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance
SERVICE_SHUTDOWN	OMAS-DATA-ENGINE-0003 The Data Engine Open Metadata Access Service (OMAS) is shutting down its instance for server

Method Summary

Modifier and Type	Method	Description
AuditLogMessageDefinition	getMessageDefinition(String... params)	Retrieve a message definition object for logging.
String	toString()
static DataEngineAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataEngineAuditCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SERVICE_INITIALIZING

public static final DataEngineAuditCode SERVICE_INITIALIZING

OMAS-DATA-ENGINE-0001 The Data Engine Open Metadata Access Service (OMAS) is initializing a new server instance

SERVICE_INITIALIZED

public static final DataEngineAuditCode SERVICE_INITIALIZED

OMAS-DATA-ENGINE-0002 The Data Engine Open Metadata Access Service (OMAS) has initialized a new instance for server

SERVICE_SHUTDOWN

public static final DataEngineAuditCode SERVICE_SHUTDOWN

OMAS-DATA-ENGINE-0003 The Data Engine Open Metadata Access Service (OMAS) is shutting down its instance for server

SERVICE_INSTANCE_FAILURE

public static final DataEngineAuditCode SERVICE_INSTANCE_FAILURE

OMAS-DATA-ENGINE-0004 The Data Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance

ERROR_INITIALIZING_TOPIC_CONNECTION

public static final DataEngineAuditCode ERROR_INITIALIZING_TOPIC_CONNECTION

OMAS-DATA-ENGINE-0005 The Data Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance

PROCESS_EVENT_EXCEPTION

public static final DataEngineAuditCode PROCESS_EVENT_EXCEPTION

OMAS-DATA-ENGINE-0006 The Data Engine Open Metadata Access Service (OMAS) is unable to process an event on its in topic

PARSE_EVENT_EXCEPTION

public static final DataEngineAuditCode PARSE_EVENT_EXCEPTION

OMAS-DATA-ENGINE-0007 The Data Engine Open Metadata Access Service (OMAS) is unable to parse an event

IN_TOPIC_EVENT_SENT

public static final DataEngineAuditCode IN_TOPIC_EVENT_SENT

OMAS-DATA-ENGINE-0008 The Data Engine Open Metadata Access Service (OMAS) client has sent an event

Method Details

values

public static DataEngineAuditCode[] 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

public static DataEngineAuditCode 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.)

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 name

NullPointerException - if the argument is null

getMessageDefinition

public AuditLogMessageDefinition getMessageDefinition(String... params)

Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.

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 String toString()

Overrides:

toString in class Enum<DataEngineAuditCode>