org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore

Class OMRSAuditLogRecord

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogRecord

All Implemented Interfaces:

Serializable

public class OMRSAuditLogRecord
extends Object
implements Serializable

OMRSAuditLogRecord provides a carrier for details about a single log record in the OMRS audit log.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMRSAuditLogRecord() Default constructor
OMRSAuditLogRecord(OMRSAuditLogRecord template) Copy/clone constructor
OMRSAuditLogRecord(OMRSAuditLogRecordOriginator originator, OMRSAuditLogReportingComponent reportingComponent, String severity, String messageId, String messageText, List<String> additionalInformation, String systemAction, String userAction) Audit log records are immutable so the only way to update the values is through the constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Validate that an object is equal depending on their stored values.
List<String>	getAdditionalInformation() Return any additional information in the audit log record.
String	getExceptionClassName() Return the name of any exception linked to the audit log record.
String	getExceptionMessage() Return the name of the message associated with any exception linked to the audit log record.
String	getExceptionStackTrace() Return the stack trace associated with any exception linked to the audit log record.
String	getGUID() Return the unique Id of the audit log record.
String	getMessageId() Return the identifier of the message within the log record.
String	getMessageText() Return the text of the message within the log record.
OMRSAuditLogRecordOriginator	getOriginator() Return details of the originator of the log record.
OMRSAuditLogReportingComponent	getReportingComponent() Return the name of the component that reported the situation recorded in the log record.
String	getSeverity() Return the severity of the situation recorded in the log record.
String	getSystemAction() Return the description of the actions taken by the local server as a result of the reported situation.
Date	getTimeStamp() Return the time stamp for when the audit log record was created.
String	getUserAction() Return details of the actions (if any) that a user can take in response to the reported situation.
int	hashCode() Return a hash code based on the values of this object.
void	setAdditionalInformation(List<String> additionalInformation) Set up any additional information in the audit log record.
void	setExceptionClassName(String exceptionClassName) Set up the name of any exception linked to the audit log record.
void	setExceptionMessage(String exceptionMessage) Set up the name of the message associated with any exception linked to the audit log record.
void	setExceptionStackTrace(String exceptionStackTrace) Set up the stack trace associated with any exception linked to the audit log record.
void	setGUID(String guid) Set up the unique Id of the audit log record.
void	setMessageId(String messageId) Set up the identifier of the message within the log record.
void	setMessageText(String messageText) Set up the text of the message within the log record.
void	setOriginator(OMRSAuditLogRecordOriginator originator) Set up details of the originator of the log record.
void	setReportingComponent(OMRSAuditLogReportingComponent reportingComponent) Set up the name of the component that reported the situation recorded in the log record.
void	setSeverity(String severity) Set up the severity of the situation recorded in the log record.
void	setSystemAction(String systemAction) Set up the description of the actions taken by the local server as a result of the reported situation.
void	setTimeStamp(Date timeStamp) Set up the time stamp for when the audit log record was created.
void	setUserAction(String userAction) Set up details of the actions (if any) that a user can take in response to the reported situation.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OMRSAuditLogRecord

public OMRSAuditLogRecord()

Default constructor

OMRSAuditLogRecord

public OMRSAuditLogRecord(OMRSAuditLogRecord template)

Copy/clone constructor

Parameters:

template - object to copy

OMRSAuditLogRecord

public OMRSAuditLogRecord(OMRSAuditLogRecordOriginator originator,
                          OMRSAuditLogReportingComponent reportingComponent,
                          String severity,
                          String messageId,
                          String messageText,
                          List<String> additionalInformation,
                          String systemAction,
                          String userAction)

Audit log records are immutable so the only way to update the values is through the constructor.

Parameters:

originator - details of the originating server

reportingComponent - details of the component making the audit log entry.

severity - OMRSAuditLogRecordSeverity enum that indicates the severity of log record.

messageId - id of the message in the audit log record.

messageText - description of the message for the audit log record.

additionalInformation - additional properties that help to describe the situation.

systemAction - action taken by the system.

userAction - followup action that should be taken by the target end user (typically the server administrator).

Method Detail

getGUID

public String getGUID()

Return the unique Id of the audit log record.

Returns:

String guid

setGUID

public void setGUID(String guid)

Set up the unique Id of the audit log record.

Parameters:

guid - String guid

getTimeStamp

public Date getTimeStamp()

Return the time stamp for when the audit log record was created.

Returns:

Date object

setTimeStamp

public void setTimeStamp(Date timeStamp)

Set up the time stamp for when the audit log record was created.

Parameters:

timeStamp - Date object

getOriginator

public OMRSAuditLogRecordOriginator getOriginator()

Return details of the originator of the log record.

Returns:

OMRSAuditLogRecordOriginator object

setOriginator

public void setOriginator(OMRSAuditLogRecordOriginator originator)

Set up details of the originator of the log record.

Parameters:

originator - calling component

getSeverity

public String getSeverity()

Return the severity of the situation recorded in the log record.

Returns:

String severity

setSeverity

public void setSeverity(String severity)

Set up the severity of the situation recorded in the log record.

Parameters:

severity - String severity

getReportingComponent

public OMRSAuditLogReportingComponent getReportingComponent()

Return the name of the component that reported the situation recorded in the log record.

Returns:

OMRSAuditLogReportingComponent object

setReportingComponent

public void setReportingComponent(OMRSAuditLogReportingComponent reportingComponent)

Set up the name of the component that reported the situation recorded in the log record.

Parameters:

reportingComponent - OMRSAuditLogReportingComponent object

getMessageId

public String getMessageId()

Return the identifier of the message within the log record.

Returns:

String message id

setMessageId

public void setMessageId(String messageId)

Set up the identifier of the message within the log record.

Parameters:

messageId - String message id

getMessageText

public String getMessageText()

Return the text of the message within the log record.

Returns:

String message text

setMessageText

public void setMessageText(String messageText)

Set up the text of the message within the log record.

Parameters:

messageText - String message text

getAdditionalInformation

public List<String> getAdditionalInformation()

Return any additional information in the audit log record.

Returns:

List of String additional information

setAdditionalInformation

public void setAdditionalInformation(List<String> additionalInformation)

Set up any additional information in the audit log record.

Parameters:

additionalInformation - List of String additional information

getSystemAction

public String getSystemAction()

Return the description of the actions taken by the local server as a result of the reported situation.

Returns:

string description

setSystemAction

public void setSystemAction(String systemAction)

Set up the description of the actions taken by the local server as a result of the reported situation.

Parameters:

systemAction - a description of the actions taken by the system as a result of the error.

getUserAction

public String getUserAction()

Return details of the actions (if any) that a user can take in response to the reported situation.

Returns:

String instructions

setUserAction

public void setUserAction(String userAction)

Set up details of the actions (if any) that a user can take in response to the reported situation.

Parameters:

userAction - String instructions

getExceptionClassName

public String getExceptionClassName()

Return the name of any exception linked to the audit log record.

Returns:

the class name

setExceptionClassName

public void setExceptionClassName(String exceptionClassName)

Set up the name of any exception linked to the audit log record.

Parameters:

exceptionClassName - string name

getExceptionMessage

public String getExceptionMessage()

Return the name of the message associated with any exception linked to the audit log record.

Returns:

string message

setExceptionMessage

public void setExceptionMessage(String exceptionMessage)

Set up the name of the message associated with any exception linked to the audit log record.

Parameters:

exceptionMessage - string message

getExceptionStackTrace

public String getExceptionStackTrace()

Return the stack trace associated with any exception linked to the audit log record.

Returns:

string stack trace

setExceptionStackTrace

public void setExceptionStackTrace(String exceptionStackTrace)

Set up the stack trace associated with any exception linked to the audit log record.

Parameters:

exceptionStackTrace - string stack trace

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Validate that an object is equal depending on their stored values.

Overrides:

equals in class Object

Parameters:

objectToCompare - object

Returns:

boolean result

hashCode

public int hashCode()

Return a hash code based on the values of this object.

Overrides:

hashCode in class Object

Returns:

in hash code