Package org.odpi.openmetadata.adapters.eventbus.topic.kafka

Enum Class KafkaOpenMetadataTopicConnectorAuditCode

java.lang.Object

java.lang.Enum<KafkaOpenMetadataTopicConnectorAuditCode>

org.odpi.openmetadata.adapters.eventbus.topic.kafka.KafkaOpenMetadataTopicConnectorAuditCode

All Implemented Interfaces:

Serializable, Comparable<KafkaOpenMetadataTopicConnectorAuditCode>, Constable, AuditLogMessageSet

public enum KafkaOpenMetadataTopicConnectorAuditCode
extends Enum<KafkaOpenMetadataTopicConnectorAuditCode>
implements AuditLogMessageSet

The KafkaOpenMetadataTopicConnectorAuditCode is used to define the message content for the Audit Log. The 5 fields in the enum are:

• Log Message Identifier - 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
• 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
ERROR_CONNECTING_KAFKA_PRODUCER
EVENT_SEND_IN_ERROR_LOOP
EXCEPTION_COMMITTING_OFFSETS
EXCEPTION_DISTRIBUTING_EVENT
EXCEPTION_RECEIVING_EVENT
FAILED_TO_COMMIT_CONSUMED_EVENTS
KAFKA_CONNECTION_RETRY
KAFKA_PRODUCER_SHUTDOWN
KAFKA_PRODUCER_START
MISSING_PROPERTY
NO_TOPIC_NAME
NULL_ADDITIONAL_PROPERTIES
SERVICE_CONSUMER_PROPERTIES
SERVICE_FAILED_INITIALIZING
SERVICE_INITIALIZING
SERVICE_PRODUCER_PROPERTIES
SERVICE_SHUTDOWN
UNABLE_TO_PARSE_CONFIG_PROPERTIES
UNEXPECTED_SHUTDOWN_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()	JSON-style toString
static KafkaOpenMetadataTopicConnectorAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KafkaOpenMetadataTopicConnectorAuditCode[]	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

SERVICE_INITIALIZING

public static final KafkaOpenMetadataTopicConnectorAuditCode SERVICE_INITIALIZING

SERVICE_PRODUCER_PROPERTIES

public static final KafkaOpenMetadataTopicConnectorAuditCode SERVICE_PRODUCER_PROPERTIES

SERVICE_CONSUMER_PROPERTIES

public static final KafkaOpenMetadataTopicConnectorAuditCode SERVICE_CONSUMER_PROPERTIES

SERVICE_SHUTDOWN

public static final KafkaOpenMetadataTopicConnectorAuditCode SERVICE_SHUTDOWN

NULL_ADDITIONAL_PROPERTIES

public static final KafkaOpenMetadataTopicConnectorAuditCode NULL_ADDITIONAL_PROPERTIES

UNABLE_TO_PARSE_CONFIG_PROPERTIES

public static final KafkaOpenMetadataTopicConnectorAuditCode UNABLE_TO_PARSE_CONFIG_PROPERTIES

NO_TOPIC_NAME

public static final KafkaOpenMetadataTopicConnectorAuditCode NO_TOPIC_NAME

EXCEPTION_RECEIVING_EVENT

public static final KafkaOpenMetadataTopicConnectorAuditCode EXCEPTION_RECEIVING_EVENT

EXCEPTION_DISTRIBUTING_EVENT

public static final KafkaOpenMetadataTopicConnectorAuditCode EXCEPTION_DISTRIBUTING_EVENT

KAFKA_PRODUCER_START

public static final KafkaOpenMetadataTopicConnectorAuditCode KAFKA_PRODUCER_START

KAFKA_PRODUCER_SHUTDOWN

public static final KafkaOpenMetadataTopicConnectorAuditCode KAFKA_PRODUCER_SHUTDOWN

EVENT_SEND_IN_ERROR_LOOP

public static final KafkaOpenMetadataTopicConnectorAuditCode EVENT_SEND_IN_ERROR_LOOP

MISSING_PROPERTY

public static final KafkaOpenMetadataTopicConnectorAuditCode MISSING_PROPERTY

SERVICE_FAILED_INITIALIZING

public static final KafkaOpenMetadataTopicConnectorAuditCode SERVICE_FAILED_INITIALIZING

KAFKA_CONNECTION_RETRY

public static final KafkaOpenMetadataTopicConnectorAuditCode KAFKA_CONNECTION_RETRY

UNEXPECTED_SHUTDOWN_EXCEPTION

public static final KafkaOpenMetadataTopicConnectorAuditCode UNEXPECTED_SHUTDOWN_EXCEPTION

EXCEPTION_COMMITTING_OFFSETS

public static final KafkaOpenMetadataTopicConnectorAuditCode EXCEPTION_COMMITTING_OFFSETS

FAILED_TO_COMMIT_CONSUMED_EVENTS

public static final KafkaOpenMetadataTopicConnectorAuditCode FAILED_TO_COMMIT_CONSUMED_EVENTS

ERROR_CONNECTING_KAFKA_PRODUCER

public static final KafkaOpenMetadataTopicConnectorAuditCode ERROR_CONNECTING_KAFKA_PRODUCER

Method Details

values

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

JSON-style toString

Overrides:

toString in class Enum<KafkaOpenMetadataTopicConnectorAuditCode>

Returns:

string of property names and values for this enum