Package org.odpi.openmetadata.frameworks.auditlog

Class AuditLogRecord

java.lang.Object
org.odpi.openmetadata.frameworks.auditlog.AuditLogRecord
Direct Known Subclasses:
OMRSAuditLogRecord
public class AuditLogRecord extends Object
AuditLogRecord provides a carrier for details about a single log record in the audit log.

  • Constructor Details

    • AuditLogRecord

      public AuditLogRecord()
      Default constructor

    • AuditLogRecord

      public AuditLogRecord(AuditLogRecord template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getGUID

      public String getGUID()
      Return the unique Identifier of the audit log record.
      Returns:
      String guid

    • setGUID

      public void setGUID(String guid)
      Set up the unique Identifier 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

    • getOriginatorProperties

      public Map<String,String> getOriginatorProperties()
      Return details of the originator of the log record.
      Returns:
      map of name value pairs

    • setOriginatorProperties

      public void setOriginatorProperties(Map<String,String> originatorProperties)
      Set up details of the originator of the log record.
      Parameters:
      originatorProperties - map of name value pairs

    • getOriginatorComponent

      public AuditLogReportingComponent getOriginatorComponent()
      Return the name of the component that reported the situation recorded in the log record.
      Returns:
      ComponentDescription object

    • setOriginatorComponent

      public void setOriginatorComponent(AuditLogReportingComponent originatorComponent)
      Set up the name of the component that reported the situation recorded in the log record.
      Parameters:
      originatorComponent - ComponentDescription object

    • getActionDescription

      public String getActionDescription()
      Return the description of the activity that this log record relates.
      Returns:
      string description

    • setActionDescription

      public void setActionDescription(String actionDescription)
      Set up the description of the activity that this log record relates.
      Parameters:
      actionDescription - string description

    • getThreadId

      public long getThreadId()
      Return the identifier of the thread where the situation occurred. This is useful for correlating records in a multi-threaded environment.
      Returns:
      long id

    • setThreadId

      public void setThreadId(long threadId)
      Set up the identifier of the thread where the situation occurred.
      Parameters:
      threadId - long id

    • getThreadName

      public String getThreadName()
      Return the name of the thread where the situation occurred.
      Returns:
      string name

    • setThreadName

      public void setThreadName(String threadName)
      Set up he name of the thread where the situation occurred.
      Parameters:
      threadName - string name

    • getSeverityCode

      public int getSeverityCode()
      Return the severity of the situation recorded in the log record.
      Returns:
      int unique id for the severity

    • setSeverityCode

      public void setSeverityCode(int severityCode)
      Set up the severity of the situation recorded in the log record.
      Parameters:
      severityCode - unique id for the severity

    • 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

    • 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

    • getMessageParameters

      public String[] getMessageParameters()
      Return the array of values that were inserted in the message text.
      Returns:
      array of strings

    • setMessageParameters

      public void setMessageParameters(String[] messageParameters)
      Set up the array of values that were inserted in the message text.
      Parameters:
      messageParameters - array of strings

    • 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