org.odpi.openmetadata.adminservices.ffdc

Enum OMAGAdminAuditCode

java.lang.Object

java.lang.Enum<OMAGAdminAuditCode>

org.odpi.openmetadata.adminservices.ffdc.OMAGAdminAuditCode

All Implemented Interfaces:

Serializable, Comparable<OMAGAdminAuditCode>, AuditLogMessageSet

public enum OMAGAdminAuditCode
extends Enum<OMAGAdminAuditCode>
implements AuditLogMessageSet

The OMAGAdminAuditCode 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
ACCESS_SERVICE_FAILURE
ACCESS_SERVICE_INSTANCE_FAILURE
ALL_ACCESS_SERVICES_STARTED
ALL_ACCESS_SERVICES_STOPPED
ALL_VIEW_SERVICES_STARTED
ALL_VIEW_SERVICES_STOPPED
ALL_ZONES
BAD_ACCESS_SERVICE_ADMIN_CLASS
BAD_CONFIG_PROPERTY
BAD_TOPIC_CONNECTOR
BAD_TOPIC_CONNECTOR_PROVIDER
BAD_VIEW_SERVICE_ADMIN_CLASS
DEFAULT_PLATEAU_THRESHOLD
DEFAULT_ZONES
GOVERNANCE_SERVICE_FAILURE
GOVERNANCE_SERVICES_STARTED
INVALID_MAX_PAGE_SIZE
KARMA_POINT_COLLECTION_INCREMENT
MAX_PAGE_SIZE
NO_ENTERPRISE_TOPIC
NO_KARMA_POINT_COLLECTION
NULL_ACCESS_SERVICE_ADMIN_CLASS
NULL_VIEW_SERVICE_ADMIN_CLASS
PLATEAU_THRESHOLD
PUBLISH_ZONES
SERVER_SHUTDOWN_ERROR
SERVER_SHUTDOWN_STARTED
SERVER_SHUTDOWN_SUCCESS
SERVER_STARTUP_SUCCESS
SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC
SKIPPING_ACCESS_SERVICE
SKIPPING_VIEW_SERVICE
STARTING_ACCESS_SERVICES
STARTING_GOVERNANCE_SERVICES
STARTING_VIEW_SERVICES
STOPPING_ACCESS_SERVICES
STOPPING_VIEW_SERVICES
SUPPORTED_ZONES
UNLIMITED_MAX_PAGE_SIZE
VIEW_SERVICE_FAILURE
VIEW_SERVICE_INSTANCE_FAILURE

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAX_PAGE_SIZE

public static final OMAGAdminAuditCode MAX_PAGE_SIZE

UNLIMITED_MAX_PAGE_SIZE

public static final OMAGAdminAuditCode UNLIMITED_MAX_PAGE_SIZE

INVALID_MAX_PAGE_SIZE

public static final OMAGAdminAuditCode INVALID_MAX_PAGE_SIZE

SERVER_STARTUP_SUCCESS

public static final OMAGAdminAuditCode SERVER_STARTUP_SUCCESS

SERVER_SHUTDOWN_STARTED

public static final OMAGAdminAuditCode SERVER_SHUTDOWN_STARTED

SERVER_SHUTDOWN_SUCCESS

public static final OMAGAdminAuditCode SERVER_SHUTDOWN_SUCCESS

SERVER_SHUTDOWN_ERROR

public static final OMAGAdminAuditCode SERVER_SHUTDOWN_ERROR

STARTING_ACCESS_SERVICES

public static final OMAGAdminAuditCode STARTING_ACCESS_SERVICES

SKIPPING_ACCESS_SERVICE

public static final OMAGAdminAuditCode SKIPPING_ACCESS_SERVICE

ALL_ACCESS_SERVICES_STARTED

public static final OMAGAdminAuditCode ALL_ACCESS_SERVICES_STARTED

STOPPING_ACCESS_SERVICES

public static final OMAGAdminAuditCode STOPPING_ACCESS_SERVICES

ALL_ACCESS_SERVICES_STOPPED

public static final OMAGAdminAuditCode ALL_ACCESS_SERVICES_STOPPED

ACCESS_SERVICE_INSTANCE_FAILURE

public static final OMAGAdminAuditCode ACCESS_SERVICE_INSTANCE_FAILURE

BAD_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGAdminAuditCode BAD_ACCESS_SERVICE_ADMIN_CLASS

ACCESS_SERVICE_FAILURE

public static final OMAGAdminAuditCode ACCESS_SERVICE_FAILURE

NULL_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGAdminAuditCode NULL_ACCESS_SERVICE_ADMIN_CLASS

STARTING_VIEW_SERVICES

public static final OMAGAdminAuditCode STARTING_VIEW_SERVICES

SKIPPING_VIEW_SERVICE

public static final OMAGAdminAuditCode SKIPPING_VIEW_SERVICE

ALL_VIEW_SERVICES_STARTED

public static final OMAGAdminAuditCode ALL_VIEW_SERVICES_STARTED

STOPPING_VIEW_SERVICES

public static final OMAGAdminAuditCode STOPPING_VIEW_SERVICES

ALL_VIEW_SERVICES_STOPPED

public static final OMAGAdminAuditCode ALL_VIEW_SERVICES_STOPPED

VIEW_SERVICE_INSTANCE_FAILURE

public static final OMAGAdminAuditCode VIEW_SERVICE_INSTANCE_FAILURE

BAD_VIEW_SERVICE_ADMIN_CLASS

public static final OMAGAdminAuditCode BAD_VIEW_SERVICE_ADMIN_CLASS

VIEW_SERVICE_FAILURE

public static final OMAGAdminAuditCode VIEW_SERVICE_FAILURE

NULL_VIEW_SERVICE_ADMIN_CLASS

public static final OMAGAdminAuditCode NULL_VIEW_SERVICE_ADMIN_CLASS

STARTING_GOVERNANCE_SERVICES

public static final OMAGAdminAuditCode STARTING_GOVERNANCE_SERVICES

GOVERNANCE_SERVICES_STARTED

public static final OMAGAdminAuditCode GOVERNANCE_SERVICES_STARTED

GOVERNANCE_SERVICE_FAILURE

public static final OMAGAdminAuditCode GOVERNANCE_SERVICE_FAILURE

ALL_ZONES

public static final OMAGAdminAuditCode ALL_ZONES

SUPPORTED_ZONES

public static final OMAGAdminAuditCode SUPPORTED_ZONES

DEFAULT_ZONES

public static final OMAGAdminAuditCode DEFAULT_ZONES

KARMA_POINT_COLLECTION_INCREMENT

public static final OMAGAdminAuditCode KARMA_POINT_COLLECTION_INCREMENT

NO_KARMA_POINT_COLLECTION

public static final OMAGAdminAuditCode NO_KARMA_POINT_COLLECTION

PLATEAU_THRESHOLD

public static final OMAGAdminAuditCode PLATEAU_THRESHOLD

DEFAULT_PLATEAU_THRESHOLD

public static final OMAGAdminAuditCode DEFAULT_PLATEAU_THRESHOLD

BAD_CONFIG_PROPERTY

public static final OMAGAdminAuditCode BAD_CONFIG_PROPERTY

SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

public static final OMAGAdminAuditCode SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

NO_ENTERPRISE_TOPIC

public static final OMAGAdminAuditCode NO_ENTERPRISE_TOPIC

BAD_TOPIC_CONNECTOR

public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR

BAD_TOPIC_CONNECTOR_PROVIDER

public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR_PROVIDER

PUBLISH_ZONES

public static final OMAGAdminAuditCode PUBLISH_ZONES

Method Detail

values

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

Returns:

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

valueOf

public static OMAGAdminAuditCode 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.