org.odpi.openmetadata.accessservices.analyticsmodeling.auditlog

Enum AnalyticsModelingAuditCode

java.lang.Object

java.lang.Enum<AnalyticsModelingAuditCode>

org.odpi.openmetadata.accessservices.analyticsmodeling.auditlog.AnalyticsModelingAuditCode

All Implemented Interfaces:

Serializable, Comparable<AnalyticsModelingAuditCode>, AuditLogMessageSet

public enum AnalyticsModelingAuditCode
extends Enum<AnalyticsModelingAuditCode>
implements AuditLogMessageSet

The AnalyticsModelingAuditCode 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 and Description
ERROR_INITIALIZING_CONNECTION
FIND_ENTITIES
SERVICE_INITIALIZED
SERVICE_INITIALIZING
SERVICE_INSTANCE_TERMINATION_FAILURE
SERVICE_REGISTERED_WITH_OUT_TOPIC
SERVICE_SHUTDOWN

Method Summary

Modifier and Type	Method and Description
static AuditLogMessageDefinition	getAuditLogMessageDefinition(MessageDefinition msg, String... params) Build Audit log message from message definition of error code.
AuditLogMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
AuditLogMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for an exception.
static AnalyticsModelingAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnalyticsModelingAuditCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVICE_INITIALIZING

public static final AnalyticsModelingAuditCode SERVICE_INITIALIZING

SERVICE_REGISTERED_WITH_OUT_TOPIC

public static final AnalyticsModelingAuditCode SERVICE_REGISTERED_WITH_OUT_TOPIC

SERVICE_INITIALIZED

public static final AnalyticsModelingAuditCode SERVICE_INITIALIZED

SERVICE_SHUTDOWN

public static final AnalyticsModelingAuditCode SERVICE_SHUTDOWN

ERROR_INITIALIZING_CONNECTION

public static final AnalyticsModelingAuditCode ERROR_INITIALIZING_CONNECTION

SERVICE_INSTANCE_TERMINATION_FAILURE

public static final AnalyticsModelingAuditCode SERVICE_INSTANCE_TERMINATION_FAILURE

FIND_ENTITIES

public static final AnalyticsModelingAuditCode FIND_ENTITIES

Method Detail

values

public static AnalyticsModelingAuditCode[] 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 (AnalyticsModelingAuditCode c : AnalyticsModelingAuditCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnalyticsModelingAuditCode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMessageDefinition

public AuditLogMessageDefinition getMessageDefinition()

Retrieve a message definition object for an exception. This method is used when there are no message inserts.

Specified by:

getMessageDefinition in interface AuditLogMessageSet

Returns:

message definition object.

getMessageDefinition

public AuditLogMessageDefinition getMessageDefinition(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 interface AuditLogMessageSet

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.

getAuditLogMessageDefinition

public static AuditLogMessageDefinition getAuditLogMessageDefinition(MessageDefinition msg,
                                                                     String... params)

Build Audit log message from message definition of error code.

Parameters:

msg - message definition of the error code source.

params - array of parameters (all strings) inserted into the message according to the numbering in the message text.

Returns:

message that can be logged always is EXCEPTION severity. Note: it is often operation to log an exception - make it as AuditLogMessageDefinition interface.