Package org.odpi.openmetadata.engineservices.repositorygovernance.ffdc

Enum RepositoryGovernanceAuditCode

java.lang.Object

java.lang.Enum<RepositoryGovernanceAuditCode>

org.odpi.openmetadata.engineservices.repositorygovernance.ffdc.RepositoryGovernanceAuditCode

All Implemented Interfaces:

Serializable, Comparable<RepositoryGovernanceAuditCode>, AuditLogMessageSet

public enum RepositoryGovernanceAuditCode
extends Enum<RepositoryGovernanceAuditCode>
implements AuditLogMessageSet

The RepositoryGovernanceAuditCode 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
CLEARING_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG
CONFIGURATION_LISTENER_REGISTERED
ENGINE_INITIALIZED
ENGINE_INITIALIZING
ENGINE_SERVICE_INITIALIZING
EXC_ON_ERROR_STATUS_UPDATE
FINISHED_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG
INVALID_REPOSITORY_GOVERNANCE_SERVICE
NO_CONFIGURATION_LISTENER
NO_REPOSITORY_GOVERNANCE_ENGINES_STARTED
NO_SUPPORTED_REQUEST_TYPES
REPOSITORY_GOVERNANCE_ENGINE_NO_CONFIG
REPOSITORY_GOVERNANCE_SERVICE_COMPLETE
REPOSITORY_GOVERNANCE_SERVICE_FAILED
REPOSITORY_GOVERNANCE_SERVICE_NO_CONFIG
REPOSITORY_GOVERNANCE_SERVICE_RETURNED
REPOSITORY_GOVERNANCE_SERVICE_STARTING
REQUEST_TYPE_CONFIG_ERROR
SERVER_INITIALIZED
SERVER_NOT_AUTHORIZED
SERVER_SHUTDOWN
SERVER_SHUTTING_DOWN
SERVICE_INSTANCE_FAILURE
SUPPORTED_REPOSITORY_GOVERNANCE_TYPE
UNKNOWN_REPOSITORY_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 RepositoryGovernanceAuditCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RepositoryGovernanceAuditCode[]	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 RepositoryGovernanceAuditCode ENGINE_SERVICE_INITIALIZING

ENGINE_INITIALIZING

public static final RepositoryGovernanceAuditCode ENGINE_INITIALIZING

SERVER_NOT_AUTHORIZED

public static final RepositoryGovernanceAuditCode SERVER_NOT_AUTHORIZED

SUPPORTED_REPOSITORY_GOVERNANCE_TYPE

public static final RepositoryGovernanceAuditCode SUPPORTED_REPOSITORY_GOVERNANCE_TYPE

NO_SUPPORTED_REQUEST_TYPES

public static final RepositoryGovernanceAuditCode NO_SUPPORTED_REQUEST_TYPES

REQUEST_TYPE_CONFIG_ERROR

public static final RepositoryGovernanceAuditCode REQUEST_TYPE_CONFIG_ERROR

ENGINE_INITIALIZED

public static final RepositoryGovernanceAuditCode ENGINE_INITIALIZED

SERVICE_INSTANCE_FAILURE

public static final RepositoryGovernanceAuditCode SERVICE_INSTANCE_FAILURE

SERVER_INITIALIZED

public static final RepositoryGovernanceAuditCode SERVER_INITIALIZED

SERVER_SHUTTING_DOWN

public static final RepositoryGovernanceAuditCode SERVER_SHUTTING_DOWN

SERVER_SHUTDOWN

public static final RepositoryGovernanceAuditCode SERVER_SHUTDOWN

REPOSITORY_GOVERNANCE_SERVICE_STARTING

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_STARTING

REPOSITORY_GOVERNANCE_SERVICE_RETURNED

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_RETURNED

REPOSITORY_GOVERNANCE_SERVICE_FAILED

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_FAILED

REPOSITORY_GOVERNANCE_SERVICE_COMPLETE

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_COMPLETE

NO_REPOSITORY_GOVERNANCE_ENGINES_STARTED

public static final RepositoryGovernanceAuditCode NO_REPOSITORY_GOVERNANCE_ENGINES_STARTED

EXC_ON_ERROR_STATUS_UPDATE

public static final RepositoryGovernanceAuditCode EXC_ON_ERROR_STATUS_UPDATE

UNKNOWN_REPOSITORY_GOVERNANCE_ENGINE_NAME

public static final RepositoryGovernanceAuditCode UNKNOWN_REPOSITORY_GOVERNANCE_ENGINE_NAME

NO_CONFIGURATION_LISTENER

public static final RepositoryGovernanceAuditCode NO_CONFIGURATION_LISTENER

CONFIGURATION_LISTENER_REGISTERED

public static final RepositoryGovernanceAuditCode CONFIGURATION_LISTENER_REGISTERED

CLEARING_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG

public static final RepositoryGovernanceAuditCode CLEARING_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG

FINISHED_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG

public static final RepositoryGovernanceAuditCode FINISHED_ALL_REPOSITORY_GOVERNANCE_SERVICE_CONFIG

REPOSITORY_GOVERNANCE_SERVICE_NO_CONFIG

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_NO_CONFIG

REPOSITORY_GOVERNANCE_ENGINE_NO_CONFIG

public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_ENGINE_NO_CONFIG

INVALID_REPOSITORY_GOVERNANCE_SERVICE

public static final RepositoryGovernanceAuditCode INVALID_REPOSITORY_GOVERNANCE_SERVICE

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

string description