Package org.odpi.openmetadata.conformance.ffdc

Enum Class ConformanceSuiteAuditCode

java.lang.Object

java.lang.Enum<ConformanceSuiteAuditCode>

org.odpi.openmetadata.conformance.ffdc.ConformanceSuiteAuditCode

All Implemented Interfaces:

Serializable, Comparable<ConformanceSuiteAuditCode>, Constable, AuditLogMessageSet

public enum ConformanceSuiteAuditCode
extends Enum<ConformanceSuiteAuditCode>
implements AuditLogMessageSet

The ConformanceSuiteAuditCode 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

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
ANOTHER_CONNECTED_TO_COHORT
ANOTHER_LEFT_COHORT
LOCAL_CONNECTOR_IN_COHORT
POLLING_OVERFLOW
SERVICE_INITIALIZED
SERVICE_INITIALIZING
SERVICE_INSTANCE_FAILURE
SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC
SERVICE_SHUTDOWN
TEST_CASE_COMPLETED
TEST_CASE_COMPLETED_SUCCESSFULLY
TEST_CASE_INITIALIZING
TEST_EXECUTION_WAITING
TUT_CONNECTED_TO_COHORT
TUT_LEFT_COHORT
WORKBENCH_COMPLETED
WORKBENCH_FAILURE
WORKBENCH_INITIALIZED
WORKBENCH_INITIALIZING
WORKBENCH_SYNC_COMPLETED
WORKBENCH_WAITING_TO_START

Method Summary

Modifier and Type	Method	Description
AuditLogMessageDefinition	getMessageDefinition()	Retrieve a message definition object for logging.
AuditLogMessageDefinition	getMessageDefinition(String... params)	Retrieve a message definition object for logging.
String	toString()	JSON-style toString
static ConformanceSuiteAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConformanceSuiteAuditCode[]	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 ConformanceSuiteAuditCode SERVICE_INITIALIZING

SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

public static final ConformanceSuiteAuditCode SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

SERVICE_INITIALIZED

public static final ConformanceSuiteAuditCode SERVICE_INITIALIZED

SERVICE_SHUTDOWN

public static final ConformanceSuiteAuditCode SERVICE_SHUTDOWN

SERVICE_INSTANCE_FAILURE

public static final ConformanceSuiteAuditCode SERVICE_INSTANCE_FAILURE

WORKBENCH_INITIALIZING

public static final ConformanceSuiteAuditCode WORKBENCH_INITIALIZING

WORKBENCH_INITIALIZED

public static final ConformanceSuiteAuditCode WORKBENCH_INITIALIZED

WORKBENCH_WAITING_TO_START

public static final ConformanceSuiteAuditCode WORKBENCH_WAITING_TO_START

WORKBENCH_FAILURE

public static final ConformanceSuiteAuditCode WORKBENCH_FAILURE

WORKBENCH_COMPLETED

public static final ConformanceSuiteAuditCode WORKBENCH_COMPLETED

WORKBENCH_SYNC_COMPLETED

public static final ConformanceSuiteAuditCode WORKBENCH_SYNC_COMPLETED

TEST_CASE_INITIALIZING

public static final ConformanceSuiteAuditCode TEST_CASE_INITIALIZING

TEST_CASE_COMPLETED

public static final ConformanceSuiteAuditCode TEST_CASE_COMPLETED

TEST_CASE_COMPLETED_SUCCESSFULLY

public static final ConformanceSuiteAuditCode TEST_CASE_COMPLETED_SUCCESSFULLY

LOCAL_CONNECTOR_IN_COHORT

public static final ConformanceSuiteAuditCode LOCAL_CONNECTOR_IN_COHORT

TUT_CONNECTED_TO_COHORT

public static final ConformanceSuiteAuditCode TUT_CONNECTED_TO_COHORT

ANOTHER_CONNECTED_TO_COHORT

public static final ConformanceSuiteAuditCode ANOTHER_CONNECTED_TO_COHORT

TUT_LEFT_COHORT

public static final ConformanceSuiteAuditCode TUT_LEFT_COHORT

ANOTHER_LEFT_COHORT

public static final ConformanceSuiteAuditCode ANOTHER_LEFT_COHORT

TEST_EXECUTION_WAITING

public static final ConformanceSuiteAuditCode TEST_EXECUTION_WAITING

POLLING_OVERFLOW

public static final ConformanceSuiteAuditCode POLLING_OVERFLOW

Method Details

values

public static ConformanceSuiteAuditCode[] 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 ConformanceSuiteAuditCode 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()

Retrieve a message definition object for logging. 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 logging. 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.

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<ConformanceSuiteAuditCode>

Returns:

string of property names and values for this enum