Package org.odpi.openmetadata.engineservices.governanceaction.ffdc

Enum GovernanceActionAuditCode

java.lang.Object

java.lang.Enum<GovernanceActionAuditCode>

org.odpi.openmetadata.engineservices.governanceaction.ffdc.GovernanceActionAuditCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceActionAuditCode>, AuditLogMessageSet

public enum GovernanceActionAuditCode
extends Enum<GovernanceActionAuditCode>
implements AuditLogMessageSet

The GovernanceActionAuditCode 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	Description
ENGINE_INITIALIZED
ENGINE_INITIALIZING
ENGINE_SERVICE_INITIALIZING
EXC_ON_ERROR_STATUS_UPDATE
GOVERNANCE_ACTION_INITIALIZED
GOVERNANCE_ACTION_SERVICE_COMPLETE
GOVERNANCE_ACTION_SERVICE_FAILED
GOVERNANCE_ACTION_SERVICE_RETURNED
GOVERNANCE_ACTION_SERVICE_STARTING
INVALID_GOVERNANCE_ACTION_SERVICE
NO_GOVERNANCE_ACTION_ENGINES_STARTED
NO_SUPPORTED_REQUEST_TYPES
NOT_GOVERNANCE_ACTION_SERVICE
REQUEST_TYPE_CONFIG_ERROR
SERVER_INITIALIZED
SERVER_NOT_AUTHORIZED
SERVER_SHUTDOWN
SERVER_SHUTTING_DOWN
SERVICE_INSTANCE_FAILURE
SUPPORTED_GOVERNANCE_ACTION_TYPE
UNKNOWN_GOVERNANCE_ACTION_SERVICE
WATCHDOG_LISTENER_EXCEPTION

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()	toString() JSON-style
static GovernanceActionAuditCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GovernanceActionAuditCode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENGINE_SERVICE_INITIALIZING

public static final GovernanceActionAuditCode ENGINE_SERVICE_INITIALIZING

ENGINE_INITIALIZING

public static final GovernanceActionAuditCode ENGINE_INITIALIZING

SERVER_NOT_AUTHORIZED

public static final GovernanceActionAuditCode SERVER_NOT_AUTHORIZED

SUPPORTED_GOVERNANCE_ACTION_TYPE

public static final GovernanceActionAuditCode SUPPORTED_GOVERNANCE_ACTION_TYPE

NO_SUPPORTED_REQUEST_TYPES

public static final GovernanceActionAuditCode NO_SUPPORTED_REQUEST_TYPES

REQUEST_TYPE_CONFIG_ERROR

public static final GovernanceActionAuditCode REQUEST_TYPE_CONFIG_ERROR

ENGINE_INITIALIZED

public static final GovernanceActionAuditCode ENGINE_INITIALIZED

SERVICE_INSTANCE_FAILURE

public static final GovernanceActionAuditCode SERVICE_INSTANCE_FAILURE

SERVER_INITIALIZED

public static final GovernanceActionAuditCode SERVER_INITIALIZED

SERVER_SHUTTING_DOWN

public static final GovernanceActionAuditCode SERVER_SHUTTING_DOWN

SERVER_SHUTDOWN

public static final GovernanceActionAuditCode SERVER_SHUTDOWN

GOVERNANCE_ACTION_SERVICE_STARTING

public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_STARTING

GOVERNANCE_ACTION_SERVICE_FAILED

public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_FAILED

GOVERNANCE_ACTION_SERVICE_COMPLETE

public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_COMPLETE

GOVERNANCE_ACTION_SERVICE_RETURNED

public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_RETURNED

WATCHDOG_LISTENER_EXCEPTION

public static final GovernanceActionAuditCode WATCHDOG_LISTENER_EXCEPTION

NO_GOVERNANCE_ACTION_ENGINES_STARTED

public static final GovernanceActionAuditCode NO_GOVERNANCE_ACTION_ENGINES_STARTED

EXC_ON_ERROR_STATUS_UPDATE

public static final GovernanceActionAuditCode EXC_ON_ERROR_STATUS_UPDATE

INVALID_GOVERNANCE_ACTION_SERVICE

public static final GovernanceActionAuditCode INVALID_GOVERNANCE_ACTION_SERVICE

UNKNOWN_GOVERNANCE_ACTION_SERVICE

public static final GovernanceActionAuditCode UNKNOWN_GOVERNANCE_ACTION_SERVICE

NOT_GOVERNANCE_ACTION_SERVICE

public static final GovernanceActionAuditCode NOT_GOVERNANCE_ACTION_SERVICE

GOVERNANCE_ACTION_INITIALIZED

public static final GovernanceActionAuditCode GOVERNANCE_ACTION_INITIALIZED

Method Detail

values

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

Returns:

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

valueOf

public static GovernanceActionAuditCode 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 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()

toString() JSON-style

Overrides:

toString in class Enum<GovernanceActionAuditCode>

Returns:

string description