Package org.odpi.openmetadata.viewservices.actionauthor.ffdc

Enum Class ActionAuthorAuditCode

java.lang.Object

java.lang.Enum<ActionAuthorAuditCode>

org.odpi.openmetadata.viewservices.actionauthor.ffdc.ActionAuthorAuditCode

All Implemented Interfaces:

Serializable, Comparable<ActionAuthorAuditCode>, Constable, AuditLogMessageSet

public enum ActionAuthorAuditCode
extends Enum<ActionAuthorAuditCode>
implements AuditLogMessageSet

The ActionAuthorAuditCode 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

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
SERVICE_INITIALIZED	OMVS-ACTION-AUTHOR-0002 The Action Author Open Metadata View Service (OMVS) is initialized
SERVICE_INITIALIZING	OMVS-ACTION-AUTHOR-0001 The Action Author Open Metadata View Service (OMVS) is initializing
SERVICE_INSTANCE_FAILURE	OMVS-ACTION-AUTHOR-0004 The Action Author Open Metadata View Service (OMVS) is unable to initialize a new instance; error message is {0}
SERVICE_SHUTDOWN	OMVS-ACTION-AUTHOR-0003 The Action Author Open Metadata View Service (OMVS) is shutting down
SERVICE_TERMINATING	OMVS-ACTION-AUTHOR-0005 The Action Author Open Metadata View Service (OMVS) is shutting down server instance {0}
UNEXPECTED_EXCEPTION	OMVS-ACTION-AUTHOR-0006 The Open Metadata Service has generated an unexpected {0} exception during method {1}.

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 ActionAuthorAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActionAuthorAuditCode[]	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 ActionAuthorAuditCode SERVICE_INITIALIZING

OMVS-ACTION-AUTHOR-0001 The Action Author Open Metadata View Service (OMVS) is initializing

SERVICE_INITIALIZED

public static final ActionAuthorAuditCode SERVICE_INITIALIZED

OMVS-ACTION-AUTHOR-0002 The Action Author Open Metadata View Service (OMVS) is initialized

SERVICE_SHUTDOWN

public static final ActionAuthorAuditCode SERVICE_SHUTDOWN

OMVS-ACTION-AUTHOR-0003 The Action Author Open Metadata View Service (OMVS) is shutting down

SERVICE_INSTANCE_FAILURE

public static final ActionAuthorAuditCode SERVICE_INSTANCE_FAILURE

OMVS-ACTION-AUTHOR-0004 The Action Author Open Metadata View Service (OMVS) is unable to initialize a new instance; error message is {0}

SERVICE_TERMINATING

public static final ActionAuthorAuditCode SERVICE_TERMINATING

OMVS-ACTION-AUTHOR-0005 The Action Author Open Metadata View Service (OMVS) is shutting down server instance {0}

UNEXPECTED_EXCEPTION

public static final ActionAuthorAuditCode UNEXPECTED_EXCEPTION

OMVS-ACTION-AUTHOR-0006 The Open Metadata Service has generated an unexpected {0} exception during method {1}. The message was: {2}

Method Details

values

public static ActionAuthorAuditCode[] 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 ActionAuthorAuditCode 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<ActionAuthorAuditCode>

Returns:

string of property names and values for this enum