Package org.odpi.openmetadata.accessservices.governanceengine.ffdc

Enum Class GovernanceEngineAuditCode

java.lang.Object

java.lang.Enum<GovernanceEngineAuditCode>

org.odpi.openmetadata.accessservices.governanceengine.ffdc.GovernanceEngineAuditCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceEngineAuditCode>, Constable, AuditLogMessageSet

public enum GovernanceEngineAuditCode
extends Enum<GovernanceEngineAuditCode>
implements AuditLogMessageSet

The GovernanceEngineAuditLog 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
ASSET_AUDIT_LOG
BAD_GOVERNANCE_ACTION
EVENT_PROCESSING_ERROR
NEW_GOVERNANCE_ACTION
OUT_TOPIC_EVENT
OUT_TOPIC_FAILURE
OUT_TOPIC_WATCHDOG_EVENT
PUBLISHING_SHUTDOWN
PUBLISHING_SHUTDOWN_ERROR
REFRESH_GOVERNANCE_ENGINE
REFRESH_GOVERNANCE_SERVICE
SERVICE_INITIALIZED
SERVICE_INITIALIZING
SERVICE_INSTANCE_FAILURE
SERVICE_PUBLISHING
SERVICE_REGISTERED_WITH_TOPIC
SERVICE_SHUTDOWN
SERVICE_TERMINATING
SKIPPING_INSTANCE
UNEXPECTED_INITIALIZATION_EXCEPTION
WATCHDOG_EVENT

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 GovernanceEngineAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GovernanceEngineAuditCode[]	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 GovernanceEngineAuditCode SERVICE_INITIALIZING

SERVICE_REGISTERED_WITH_TOPIC

public static final GovernanceEngineAuditCode SERVICE_REGISTERED_WITH_TOPIC

SERVICE_PUBLISHING

public static final GovernanceEngineAuditCode SERVICE_PUBLISHING

SERVICE_INITIALIZED

public static final GovernanceEngineAuditCode SERVICE_INITIALIZED

SERVICE_INSTANCE_FAILURE

public static final GovernanceEngineAuditCode SERVICE_INSTANCE_FAILURE

EVENT_PROCESSING_ERROR

public static final GovernanceEngineAuditCode EVENT_PROCESSING_ERROR

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final GovernanceEngineAuditCode UNEXPECTED_INITIALIZATION_EXCEPTION

SERVICE_TERMINATING

public static final GovernanceEngineAuditCode SERVICE_TERMINATING

PUBLISHING_SHUTDOWN

public static final GovernanceEngineAuditCode PUBLISHING_SHUTDOWN

PUBLISHING_SHUTDOWN_ERROR

public static final GovernanceEngineAuditCode PUBLISHING_SHUTDOWN_ERROR

SERVICE_SHUTDOWN

public static final GovernanceEngineAuditCode SERVICE_SHUTDOWN

REFRESH_GOVERNANCE_ENGINE

public static final GovernanceEngineAuditCode REFRESH_GOVERNANCE_ENGINE

REFRESH_GOVERNANCE_SERVICE

public static final GovernanceEngineAuditCode REFRESH_GOVERNANCE_SERVICE

NEW_GOVERNANCE_ACTION

public static final GovernanceEngineAuditCode NEW_GOVERNANCE_ACTION

BAD_GOVERNANCE_ACTION

public static final GovernanceEngineAuditCode BAD_GOVERNANCE_ACTION

WATCHDOG_EVENT

public static final GovernanceEngineAuditCode WATCHDOG_EVENT

OUT_TOPIC_FAILURE

public static final GovernanceEngineAuditCode OUT_TOPIC_FAILURE

OUT_TOPIC_EVENT

public static final GovernanceEngineAuditCode OUT_TOPIC_EVENT

OUT_TOPIC_WATCHDOG_EVENT

public static final GovernanceEngineAuditCode OUT_TOPIC_WATCHDOG_EVENT

ASSET_AUDIT_LOG

public static final GovernanceEngineAuditCode ASSET_AUDIT_LOG

SKIPPING_INSTANCE

public static final GovernanceEngineAuditCode SKIPPING_INSTANCE

Method Details

values

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

Returns:

string of property names and values for this enum