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	CONFORMANCE-SUITE-0017 - Server {0} with metadata collection id {1} connected to the same cohort as the Open Metadata Conformance Suite that is configured to test a server named {2}
ANOTHER_LEFT_COHORT	CONFORMANCE-SUITE-0019 - Server {0} with metadata collection id {1} has left the cohort
LOCAL_CONNECTOR_IN_COHORT	CONFORMANCE-SUITE-0015 - The Open Metadata Conformance Suite has access to the local repository with metadata collection id {0}
POLLING_OVERFLOW	CONFORMANCE-SUITE-0021 - Test execution was polling for events {0} times every {1} ms, and has now overrun
TEST_CASE_COMPLETED	CONFORMANCE-SUITE-0013 - The Open Metadata Conformance Test Case {0} has completed with {1} successful assertions, {2} unsuccessful assertions, {3} unexpected exceptions and {4} discovered properties.
TEST_CASE_COMPLETED_SUCCESSFULLY	CONFORMANCE-SUITE-0014 - The Open Metadata Conformance Test Case {0} has completed with {1} successful assertions, {2} unsuccessful assertions, {3} unexpected exceptions and {4} discovered properties.
TEST_CASE_INITIALIZING	CONFORMANCE-SUITE-0012 - The Open Metadata Conformance Test Case {0} is initializing; see {1} for documentation
TEST_EXECUTION_WAITING	CONFORMANCE-SUITE-0020 - Test execution will now pause for {0} seconds
TUT_CONNECTED_TO_COHORT	CONFORMANCE-SUITE-0016 - The technology under test with a server name of {0} connected to the same cohort as the Open Metadata Conformance Suite with metadata collection id {1}
TUT_LEFT_COHORT	CONFORMANCE-SUITE-0018 - The technology under test with server name {0} and metadata collection id {1} has left the cohort
WORKBENCH_COMPLETED	CONFORMANCE-SUITE-0010 - The Open Metadata Conformance Workbench {0} has finished
WORKBENCH_FAILURE	CONFORMANCE-SUITE-0009 - The Open Metadata Conformance Workbench {0} is unable to run its tests; error message is {1}
WORKBENCH_INITIALIZED	CONFORMANCE-SUITE-0007 - The Open Metadata Conformance Workbench {0} has initialized
WORKBENCH_INITIALIZING	CONFORMANCE-SUITE-0006 - The Open Metadata Conformance Workbench {0} is initializing; see {1} for documentation
WORKBENCH_SYNC_COMPLETED	CONFORMANCE-SUITE-0011 - The Open Metadata Conformance Workbench {0} has completed its synchronous tests, further test cases may be triggered from incoming events
WORKBENCH_WAITING_TO_START	CONFORMANCE-SUITE-0008 - The Open Metadata Repository Conformance Workbench {0} is waiting for server {1} to join the cohort

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

WORKBENCH_INITIALIZING

public static final ConformanceSuiteAuditCode WORKBENCH_INITIALIZING

CONFORMANCE-SUITE-0006 - The Open Metadata Conformance Workbench {0} is initializing; see {1} for documentation

WORKBENCH_INITIALIZED

public static final ConformanceSuiteAuditCode WORKBENCH_INITIALIZED

CONFORMANCE-SUITE-0007 - The Open Metadata Conformance Workbench {0} has initialized

WORKBENCH_WAITING_TO_START

public static final ConformanceSuiteAuditCode WORKBENCH_WAITING_TO_START

CONFORMANCE-SUITE-0008 - The Open Metadata Repository Conformance Workbench {0} is waiting for server {1} to join the cohort

WORKBENCH_FAILURE

public static final ConformanceSuiteAuditCode WORKBENCH_FAILURE

CONFORMANCE-SUITE-0009 - The Open Metadata Conformance Workbench {0} is unable to run its tests; error message is {1}

WORKBENCH_COMPLETED

public static final ConformanceSuiteAuditCode WORKBENCH_COMPLETED

CONFORMANCE-SUITE-0010 - The Open Metadata Conformance Workbench {0} has finished

WORKBENCH_SYNC_COMPLETED

public static final ConformanceSuiteAuditCode WORKBENCH_SYNC_COMPLETED

CONFORMANCE-SUITE-0011 - The Open Metadata Conformance Workbench {0} has completed its synchronous tests, further test cases may be triggered from incoming events

TEST_CASE_INITIALIZING

public static final ConformanceSuiteAuditCode TEST_CASE_INITIALIZING

CONFORMANCE-SUITE-0012 - The Open Metadata Conformance Test Case {0} is initializing; see {1} for documentation

TEST_CASE_COMPLETED

public static final ConformanceSuiteAuditCode TEST_CASE_COMPLETED

CONFORMANCE-SUITE-0013 - The Open Metadata Conformance Test Case {0} has completed with {1} successful assertions, {2} unsuccessful assertions, {3} unexpected exceptions and {4} discovered properties.

TEST_CASE_COMPLETED_SUCCESSFULLY

public static final ConformanceSuiteAuditCode TEST_CASE_COMPLETED_SUCCESSFULLY

CONFORMANCE-SUITE-0014 - The Open Metadata Conformance Test Case {0} has completed with {1} successful assertions, {2} unsuccessful assertions, {3} unexpected exceptions and {4} discovered properties. The message on completion was: {5}

LOCAL_CONNECTOR_IN_COHORT

public static final ConformanceSuiteAuditCode LOCAL_CONNECTOR_IN_COHORT

CONFORMANCE-SUITE-0015 - The Open Metadata Conformance Suite has access to the local repository with metadata collection id {0}

TUT_CONNECTED_TO_COHORT

public static final ConformanceSuiteAuditCode TUT_CONNECTED_TO_COHORT

CONFORMANCE-SUITE-0016 - The technology under test with a server name of {0} connected to the same cohort as the Open Metadata Conformance Suite with metadata collection id {1}

ANOTHER_CONNECTED_TO_COHORT

public static final ConformanceSuiteAuditCode ANOTHER_CONNECTED_TO_COHORT

CONFORMANCE-SUITE-0017 - Server {0} with metadata collection id {1} connected to the same cohort as the Open Metadata Conformance Suite that is configured to test a server named {2}

TUT_LEFT_COHORT

public static final ConformanceSuiteAuditCode TUT_LEFT_COHORT

CONFORMANCE-SUITE-0018 - The technology under test with server name {0} and metadata collection id {1} has left the cohort

ANOTHER_LEFT_COHORT

public static final ConformanceSuiteAuditCode ANOTHER_LEFT_COHORT

CONFORMANCE-SUITE-0019 - Server {0} with metadata collection id {1} has left the cohort

TEST_EXECUTION_WAITING

public static final ConformanceSuiteAuditCode TEST_EXECUTION_WAITING

CONFORMANCE-SUITE-0020 - Test execution will now pause for {0} seconds

POLLING_OVERFLOW

public static final ConformanceSuiteAuditCode POLLING_OVERFLOW

CONFORMANCE-SUITE-0021 - Test execution was polling for events {0} times every {1} ms, and has now overrun

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