org.odpi.openmetadata.governanceservers.discoveryengineservices.ffdc

Enum DiscoveryEngineServicesAuditCode

java.lang.Object

java.lang.Enum<DiscoveryEngineServicesAuditCode>

org.odpi.openmetadata.governanceservers.discoveryengineservices.ffdc.DiscoveryEngineServicesAuditCode

All Implemented Interfaces:

Serializable, Comparable<DiscoveryEngineServicesAuditCode>, AuditLogMessageSet

public enum DiscoveryEngineServicesAuditCode
extends Enum<DiscoveryEngineServicesAuditCode>
implements AuditLogMessageSet

The DiscoveryEngineServicesAuditCode 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 and Description
CLEARING_ALL_DISCOVERY_SERVICE_CONFIG
CONFIGURATION_LISTENER_REGISTERED
DISCOVERY_ENGINE_NO_CONFIG
DISCOVERY_SERVICE_COMPLETE
DISCOVERY_SERVICE_FAILED
DISCOVERY_SERVICE_NO_CONFIG
DISCOVERY_SERVICE_STARTING
ENGINE_INITIALIZED
ENGINE_INITIALIZING
ENGINE_SHUTDOWN
EXC_ON_ERROR_STATUS_UPDATE
FINISHED_ALL_DISCOVERY_SERVICE_CONFIG
NO_CONFIGURATION_LISTENER
NO_DISCOVERY_ENGINES
NO_DISCOVERY_ENGINES_STARTED
NO_OMAS_SERVER_NAME
NO_OMAS_SERVER_URL
NO_SUPPORTED_REQUEST_TYPES
REQUEST_TYPE_CONFIG_ERROR
SERVER_INITIALIZED
SERVER_INITIALIZING
SERVER_NOT_AUTHORIZED
SERVER_SHUTDOWN
SERVER_SHUTTING_DOWN
SERVICE_INSTANCE_FAILURE
SUPPORTED_DISCOVERY_TYPE
UNKNOWN_DISCOVERY_ENGINE_NAME

Method Summary

Modifier and Type	Method and 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 DiscoveryEngineServicesAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiscoveryEngineServicesAuditCode[]	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

SERVER_INITIALIZING

public static final DiscoveryEngineServicesAuditCode SERVER_INITIALIZING

NO_OMAS_SERVER_URL

public static final DiscoveryEngineServicesAuditCode NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

public static final DiscoveryEngineServicesAuditCode NO_OMAS_SERVER_NAME

NO_DISCOVERY_ENGINES

public static final DiscoveryEngineServicesAuditCode NO_DISCOVERY_ENGINES

ENGINE_INITIALIZING

public static final DiscoveryEngineServicesAuditCode ENGINE_INITIALIZING

SERVER_NOT_AUTHORIZED

public static final DiscoveryEngineServicesAuditCode SERVER_NOT_AUTHORIZED

SUPPORTED_DISCOVERY_TYPE

public static final DiscoveryEngineServicesAuditCode SUPPORTED_DISCOVERY_TYPE

NO_SUPPORTED_REQUEST_TYPES

public static final DiscoveryEngineServicesAuditCode NO_SUPPORTED_REQUEST_TYPES

REQUEST_TYPE_CONFIG_ERROR

public static final DiscoveryEngineServicesAuditCode REQUEST_TYPE_CONFIG_ERROR

ENGINE_INITIALIZED

public static final DiscoveryEngineServicesAuditCode ENGINE_INITIALIZED

SERVICE_INSTANCE_FAILURE

public static final DiscoveryEngineServicesAuditCode SERVICE_INSTANCE_FAILURE

SERVER_INITIALIZED

public static final DiscoveryEngineServicesAuditCode SERVER_INITIALIZED

SERVER_SHUTTING_DOWN

public static final DiscoveryEngineServicesAuditCode SERVER_SHUTTING_DOWN

ENGINE_SHUTDOWN

public static final DiscoveryEngineServicesAuditCode ENGINE_SHUTDOWN

SERVER_SHUTDOWN

public static final DiscoveryEngineServicesAuditCode SERVER_SHUTDOWN

DISCOVERY_SERVICE_STARTING

public static final DiscoveryEngineServicesAuditCode DISCOVERY_SERVICE_STARTING

DISCOVERY_SERVICE_FAILED

public static final DiscoveryEngineServicesAuditCode DISCOVERY_SERVICE_FAILED

DISCOVERY_SERVICE_COMPLETE

public static final DiscoveryEngineServicesAuditCode DISCOVERY_SERVICE_COMPLETE

NO_DISCOVERY_ENGINES_STARTED

public static final DiscoveryEngineServicesAuditCode NO_DISCOVERY_ENGINES_STARTED

EXC_ON_ERROR_STATUS_UPDATE

public static final DiscoveryEngineServicesAuditCode EXC_ON_ERROR_STATUS_UPDATE

UNKNOWN_DISCOVERY_ENGINE_NAME

public static final DiscoveryEngineServicesAuditCode UNKNOWN_DISCOVERY_ENGINE_NAME

NO_CONFIGURATION_LISTENER

public static final DiscoveryEngineServicesAuditCode NO_CONFIGURATION_LISTENER

CONFIGURATION_LISTENER_REGISTERED

public static final DiscoveryEngineServicesAuditCode CONFIGURATION_LISTENER_REGISTERED

CLEARING_ALL_DISCOVERY_SERVICE_CONFIG

public static final DiscoveryEngineServicesAuditCode CLEARING_ALL_DISCOVERY_SERVICE_CONFIG

FINISHED_ALL_DISCOVERY_SERVICE_CONFIG

public static final DiscoveryEngineServicesAuditCode FINISHED_ALL_DISCOVERY_SERVICE_CONFIG

DISCOVERY_SERVICE_NO_CONFIG

public static final DiscoveryEngineServicesAuditCode DISCOVERY_SERVICE_NO_CONFIG

DISCOVERY_ENGINE_NO_CONFIG

public static final DiscoveryEngineServicesAuditCode DISCOVERY_ENGINE_NO_CONFIG

Method Detail

values

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

Returns:

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

valueOf

public static DiscoveryEngineServicesAuditCode 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<DiscoveryEngineServicesAuditCode>

Returns:

string description