Package org.odpi.openmetadata.governanceservers.enginehostservices.ffdc

Enum Class EngineHostServicesAuditCode

java.lang.Object

java.lang.Enum<EngineHostServicesAuditCode>

org.odpi.openmetadata.governanceservers.enginehostservices.ffdc.EngineHostServicesAuditCode

All Implemented Interfaces:

Serializable, Comparable<EngineHostServicesAuditCode>, Constable, AuditLogMessageSet

public enum EngineHostServicesAuditCode
extends Enum<EngineHostServicesAuditCode>
implements AuditLogMessageSet

The EngineHostServicesAuditCode 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
ACTION_PROCESSING_ERROR
ALL_ENGINE_SERVICES_STARTED
BAD_ENGINE_SERVICE_ADMIN_CLASS
CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG
CONFIGURATION_LISTENER_REGISTERED
ENGINE_SERVICE_INSTANCE_FAILURE
ENGINE_SERVICE_NULL_HANDLERS
ENGINE_SHUTDOWN
EXC_ON_ERROR_STATUS_UPDATE
FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG
GOVERNANCE_ACTION_FAILED
GOVERNANCE_ACTION_RECORD_COMPLETION
GOVERNANCE_ACTION_TARGET_COMPLETION
GOVERNANCE_ENGINE_NO_CONFIG
GOVERNANCE_SERVICE_NO_CONFIG
NO_CONFIG_OMAS_SERVER_NAME
NO_CONFIG_OMAS_SERVER_URL
NO_CONFIGURATION_LISTENER
NO_ENGINES
NO_ENGINES_FOR_SERVICE
NO_OMAS_SERVER_NAME
NO_OMAS_SERVER_URL
NO_PARTNER_OMAS_SERVER_NAME
NO_PARTNER_OMAS_SERVER_URL
NO_SUPPORTED_REQUEST_TYPES
NULL_ENGINE_NAME
NULL_ENGINE_SERVICE_ADMIN_CLASS
REQUEST_TYPE_CONFIG_ERROR
SERVER_INITIALIZED
SERVER_INITIALIZING
SERVER_NOT_AUTHORIZED
SERVER_SHUTDOWN
SERVER_SHUTTING_DOWN
SERVICE_INSTANCE_FAILURE
SKIPPING_ENGINE_SERVICE
STARTING_ENGINE_SERVICES
SUPPORTED_REQUEST_TYPE
UNKNOWN_GOVERNANCE_ENGINE_NAME

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

SERVER_INITIALIZING

public static final EngineHostServicesAuditCode SERVER_INITIALIZING

SERVER_INITIALIZED

public static final EngineHostServicesAuditCode SERVER_INITIALIZED

SERVICE_INSTANCE_FAILURE

public static final EngineHostServicesAuditCode SERVICE_INSTANCE_FAILURE

NO_CONFIG_OMAS_SERVER_URL

public static final EngineHostServicesAuditCode NO_CONFIG_OMAS_SERVER_URL

NO_CONFIG_OMAS_SERVER_NAME

public static final EngineHostServicesAuditCode NO_CONFIG_OMAS_SERVER_NAME

NO_PARTNER_OMAS_SERVER_URL

public static final EngineHostServicesAuditCode NO_PARTNER_OMAS_SERVER_URL

NO_PARTNER_OMAS_SERVER_NAME

public static final EngineHostServicesAuditCode NO_PARTNER_OMAS_SERVER_NAME

NO_ENGINES_FOR_SERVICE

public static final EngineHostServicesAuditCode NO_ENGINES_FOR_SERVICE

NULL_ENGINE_NAME

public static final EngineHostServicesAuditCode NULL_ENGINE_NAME

NULL_ENGINE_SERVICE_ADMIN_CLASS

public static final EngineHostServicesAuditCode NULL_ENGINE_SERVICE_ADMIN_CLASS

BAD_ENGINE_SERVICE_ADMIN_CLASS

public static final EngineHostServicesAuditCode BAD_ENGINE_SERVICE_ADMIN_CLASS

STARTING_ENGINE_SERVICES

public static final EngineHostServicesAuditCode STARTING_ENGINE_SERVICES

ENGINE_SERVICE_NULL_HANDLERS

public static final EngineHostServicesAuditCode ENGINE_SERVICE_NULL_HANDLERS

ALL_ENGINE_SERVICES_STARTED

public static final EngineHostServicesAuditCode ALL_ENGINE_SERVICES_STARTED

ENGINE_SHUTDOWN

public static final EngineHostServicesAuditCode ENGINE_SHUTDOWN

SKIPPING_ENGINE_SERVICE

public static final EngineHostServicesAuditCode SKIPPING_ENGINE_SERVICE

SERVER_SHUTTING_DOWN

public static final EngineHostServicesAuditCode SERVER_SHUTTING_DOWN

SERVER_SHUTDOWN

public static final EngineHostServicesAuditCode SERVER_SHUTDOWN

SERVER_NOT_AUTHORIZED

public static final EngineHostServicesAuditCode SERVER_NOT_AUTHORIZED

ENGINE_SERVICE_INSTANCE_FAILURE

public static final EngineHostServicesAuditCode ENGINE_SERVICE_INSTANCE_FAILURE

SUPPORTED_REQUEST_TYPE

public static final EngineHostServicesAuditCode SUPPORTED_REQUEST_TYPE

NO_SUPPORTED_REQUEST_TYPES

public static final EngineHostServicesAuditCode NO_SUPPORTED_REQUEST_TYPES

REQUEST_TYPE_CONFIG_ERROR

public static final EngineHostServicesAuditCode REQUEST_TYPE_CONFIG_ERROR

EXC_ON_ERROR_STATUS_UPDATE

public static final EngineHostServicesAuditCode EXC_ON_ERROR_STATUS_UPDATE

UNKNOWN_GOVERNANCE_ENGINE_NAME

public static final EngineHostServicesAuditCode UNKNOWN_GOVERNANCE_ENGINE_NAME

NO_CONFIGURATION_LISTENER

public static final EngineHostServicesAuditCode NO_CONFIGURATION_LISTENER

CONFIGURATION_LISTENER_REGISTERED

public static final EngineHostServicesAuditCode CONFIGURATION_LISTENER_REGISTERED

CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG

public static final EngineHostServicesAuditCode CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG

FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG

public static final EngineHostServicesAuditCode FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG

GOVERNANCE_SERVICE_NO_CONFIG

public static final EngineHostServicesAuditCode GOVERNANCE_SERVICE_NO_CONFIG

GOVERNANCE_ENGINE_NO_CONFIG

public static final EngineHostServicesAuditCode GOVERNANCE_ENGINE_NO_CONFIG

GOVERNANCE_ACTION_TARGET_COMPLETION

public static final EngineHostServicesAuditCode GOVERNANCE_ACTION_TARGET_COMPLETION

GOVERNANCE_ACTION_RECORD_COMPLETION

public static final EngineHostServicesAuditCode GOVERNANCE_ACTION_RECORD_COMPLETION

GOVERNANCE_ACTION_FAILED

public static final EngineHostServicesAuditCode GOVERNANCE_ACTION_FAILED

NO_OMAS_SERVER_URL

public static final EngineHostServicesAuditCode NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

public static final EngineHostServicesAuditCode NO_OMAS_SERVER_NAME

NO_ENGINES

public static final EngineHostServicesAuditCode NO_ENGINES

ACTION_PROCESSING_ERROR

public static final EngineHostServicesAuditCode ACTION_PROCESSING_ERROR

Method Details

values

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

toString() JSON-style

Overrides:

toString in class Enum<EngineHostServicesAuditCode>

Returns:

string description