Package org.odpi.openmetadata.accessservices.securityofficer.api.ffdc

Enum SecurityOfficerAuditCode

java.lang.Object

java.lang.Enum<SecurityOfficerAuditCode>

org.odpi.openmetadata.accessservices.securityofficer.api.ffdc.SecurityOfficerAuditCode

All Implemented Interfaces:

Serializable, Comparable<SecurityOfficerAuditCode>, AuditLogMessageSet

public enum SecurityOfficerAuditCode
extends Enum<SecurityOfficerAuditCode>
implements AuditLogMessageSet

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_INITIALIZING_TOPIC_CONNECTION
EVENT_PROCESSING_ERROR
OUT_TOPIC_EVENT
OUT_TOPIC_FAILURE
PUBLISH_EVENT_EXCEPTION
SERVICE_INITIALIZED
SERVICE_INITIALIZING
SERVICE_INSTANCE_FAILURE
SERVICE_REGISTERED_WITH_TOPIC
SERVICE_SHUTDOWN
SERVICE_TERMINATING
UNEXPECTED_INITIALIZATION_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 SecurityOfficerAuditCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SecurityOfficerAuditCode[]	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

SERVICE_INITIALIZING

public static final SecurityOfficerAuditCode SERVICE_INITIALIZING

SERVICE_REGISTERED_WITH_TOPIC

public static final SecurityOfficerAuditCode SERVICE_REGISTERED_WITH_TOPIC

SERVICE_INITIALIZED

public static final SecurityOfficerAuditCode SERVICE_INITIALIZED

SERVICE_TERMINATING

public static final SecurityOfficerAuditCode SERVICE_TERMINATING

SERVICE_SHUTDOWN

public static final SecurityOfficerAuditCode SERVICE_SHUTDOWN

SERVICE_INSTANCE_FAILURE

public static final SecurityOfficerAuditCode SERVICE_INSTANCE_FAILURE

ERROR_INITIALIZING_TOPIC_CONNECTION

public static final SecurityOfficerAuditCode ERROR_INITIALIZING_TOPIC_CONNECTION

PUBLISH_EVENT_EXCEPTION

public static final SecurityOfficerAuditCode PUBLISH_EVENT_EXCEPTION

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final SecurityOfficerAuditCode UNEXPECTED_INITIALIZATION_EXCEPTION

EVENT_PROCESSING_ERROR

public static final SecurityOfficerAuditCode EVENT_PROCESSING_ERROR

OUT_TOPIC_FAILURE

public static final SecurityOfficerAuditCode OUT_TOPIC_FAILURE

OUT_TOPIC_EVENT

public static final SecurityOfficerAuditCode OUT_TOPIC_EVENT

Method Detail

values

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

Returns:

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

valueOf

public static SecurityOfficerAuditCode 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()

JSON-style toString

Overrides:

toString in class Enum<SecurityOfficerAuditCode>

Returns:

string of property names and values for this enum