Enum DataManagerAuditCode
- java.lang.Object
-
- java.lang.Enum<DataManagerAuditCode>
-
- org.odpi.openmetadata.accessservices.datamanager.ffdc.DataManagerAuditCode
-
- All Implemented Interfaces:
Serializable
,Comparable<DataManagerAuditCode>
,AuditLogMessageSet
public enum DataManagerAuditCode extends Enum<DataManagerAuditCode> implements AuditLogMessageSet
The DataManagerAuditCode 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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 toStringstatic DataManagerAuditCode
valueOf(String name)
Returns the enum constant of this type with the specified name.static DataManagerAuditCode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SERVICE_INITIALIZING
public static final DataManagerAuditCode SERVICE_INITIALIZING
-
SERVICE_PUBLISHING
public static final DataManagerAuditCode SERVICE_PUBLISHING
-
SERVICE_INSTANCE_FAILURE
public static final DataManagerAuditCode SERVICE_INSTANCE_FAILURE
-
SERVICE_INITIALIZED
public static final DataManagerAuditCode SERVICE_INITIALIZED
-
SERVICE_SHUTDOWN
public static final DataManagerAuditCode SERVICE_SHUTDOWN
-
PUBLISHING_SHUTDOWN
public static final DataManagerAuditCode PUBLISHING_SHUTDOWN
-
PUBLISHING_SHUTDOWN_ERROR
public static final DataManagerAuditCode PUBLISHING_SHUTDOWN_ERROR
-
SERVICE_INSTANCE_TERMINATION_FAILURE
public static final DataManagerAuditCode SERVICE_INSTANCE_TERMINATION_FAILURE
-
OUT_TOPIC_EVENT
public static final DataManagerAuditCode OUT_TOPIC_EVENT
-
PROCESS_EVENT_EXCEPTION
public static final DataManagerAuditCode PROCESS_EVENT_EXCEPTION
-
OUTBOUND_EVENT_EXCEPTION
public static final DataManagerAuditCode OUTBOUND_EVENT_EXCEPTION
-
-
Method Detail
-
values
public static DataManagerAuditCode[] 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 (DataManagerAuditCode c : DataManagerAuditCode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DataManagerAuditCode 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 nameNullPointerException
- 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 interfaceAuditLogMessageSet
- 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 interfaceAuditLogMessageSet
- 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 classEnum<DataManagerAuditCode>
- Returns:
- string of property names and values for this enum
-
-