Package org.odpi.openmetadata.frameworks.auditlog.messagesets

Class AuditLogMessageDefinition

java.lang.Object

org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition

org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition

public class AuditLogMessageDefinition
extends MessageDefinition

AuditLogMessageDefinition extends MessageDefinition to provide a container that describes a single instance of a message for an audit log record.

Constructor Summary

Constructors

Constructor	Description
AuditLogMessageDefinition(String messageId, AuditLogRecordSeverity severity, String messageTemplate, String systemAction, String userAction)	Constructor to save all the fixed values of a message.
AuditLogMessageDefinition(String messageId, AuditLogRecordSeverity severity, String messageTemplate, String systemAction, String userAction, String url)	Constructor to save all the fixed values of a message, including a link to further reading.

Method Summary

Modifier and Type	Method	Description
AuditLogRecordSeverity	getSeverity()	Return the severity of the audit log record.
String	toString()	JSON-style toString.

Methods inherited from class org.odpi.openmetadata.frameworks.auditlog.messagesets.MessageDefinition

getMessageId, getMessageParams, getMessageTemplate, getSystemAction, getURL, getUserAction, setMessageParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AuditLogMessageDefinition

public AuditLogMessageDefinition(String messageId,
 AuditLogRecordSeverity severity,
 String messageTemplate,
 String systemAction,
 String userAction)

Constructor to save all the fixed values of a message. This is typically populated from an Enum message set. The constructor passes most values to the super class and just retains the additional value for the audit log.

Parameters:

messageId - unique id for the message

severity - severity of the message

messageTemplate - text for the message

systemAction - description of the action taken by the system when the condition happened

userAction - instructions for resolving the situation, if any

AuditLogMessageDefinition

public AuditLogMessageDefinition(String messageId,
 AuditLogRecordSeverity severity,
 String messageTemplate,
 String systemAction,
 String userAction,
 String url)

Constructor to save all the fixed values of a message, including a link to further reading. This is typically populated from an Enum message set. The constructor passes most values to the super class and just retains the additional value for the audit log.

Parameters:

messageId - unique id for the message

severity - severity of the message

messageTemplate - text for the message

systemAction - description of the action taken by the system when the condition happened

userAction - instructions for resolving the situation, if any

url - link to a page that describes the component or concept behind this message - null if there is no suitable page.

Method Details

getSeverity

public AuditLogRecordSeverity getSeverity()

Return the severity of the audit log record.

Returns:

OMRSAuditLogRecordSeverity enum

toString

public String toString()

JSON-style toString.

Overrides:

toString in class MessageDefinition

Returns:

list of properties and their values.