Class AuditLogRecord

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    OMRSAuditLogRecord

    public class AuditLogRecord
    extends java.lang.Object
    implements java.io.Serializable
    AuditLogRecord provides a carrier for details about a single log record in the audit log.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      java.lang.String getActionDescription()
      Return the description of the activity that this log record relates.
      java.util.List<java.lang.String> getAdditionalInformation()
      Return any additional information in the audit log record.
      java.lang.String getExceptionClassName()
      Return the name of any exception linked to the audit log record.
      java.lang.String getExceptionMessage()
      Return the name of the message associated with any exception linked to the audit log record.
      java.lang.String getExceptionStackTrace()
      Return the stack trace associated with any exception linked to the audit log record.
      java.lang.String getGUID()
      Return the unique Id of the audit log record.
      java.lang.String getMessageId()
      Return the identifier of the message within the log record.
      java.lang.String[] getMessageParameters()
      Return the array of values that were inserted in the message text.
      java.lang.String getMessageText()
      Return the text of the message within the log record.
      AuditLogReportingComponent getOriginatorComponent()
      Return the name of the component that reported the situation recorded in the log record.
      java.util.Map<java.lang.String,​java.lang.String> getOriginatorProperties()
      Return details of the originator of the log record.
      java.lang.String getSeverity()
      Return the severity of the situation recorded in the log record.
      int getSeverityCode()
      Return the severity of the situation recorded in the log record.
      java.lang.String getSystemAction()
      Return the description of the actions taken by the local server as a result of the reported situation.
      long getThreadId()
      Return the identifier of the thread where the situation occurred.
      java.lang.String getThreadName()
      Return the name of the thread where the situation occurred.
      java.util.Date getTimeStamp()
      Return the time stamp for when the audit log record was created.
      java.lang.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 setActionDescription​(java.lang.String actionDescription)
      Set up the description of the activity that this log record relates.
      void setAdditionalInformation​(java.util.List<java.lang.String> additionalInformation)
      Set up any additional information in the audit log record.
      void setExceptionClassName​(java.lang.String exceptionClassName)
      Set up the name of any exception linked to the audit log record.
      void setExceptionMessage​(java.lang.String exceptionMessage)
      Set up the name of the message associated with any exception linked to the audit log record.
      void setExceptionStackTrace​(java.lang.String exceptionStackTrace)
      Set up the stack trace associated with any exception linked to the audit log record.
      void setGUID​(java.lang.String guid)
      Set up the unique Id of the audit log record.
      void setMessageId​(java.lang.String messageId)
      Set up the identifier of the message within the log record.
      void setMessageParameters​(java.lang.String[] messageParameters)
      Set up the array of values that were inserted in the message text.
      void setMessageText​(java.lang.String messageText)
      Set up the text of the message within the log record.
      void setOriginatorComponent​(AuditLogReportingComponent originatorComponent)
      Set up the name of the component that reported the situation recorded in the log record.
      void setOriginatorProperties​(java.util.Map<java.lang.String,​java.lang.String> originatorProperties)
      Set up details of the originator of the log record.
      void setSeverity​(java.lang.String severity)
      Set up the severity of the situation recorded in the log record.
      void setSeverityCode​(int severityCode)
      Set up the severity of the situation recorded in the log record.
      void setSystemAction​(java.lang.String systemAction)
      Set up the description of the actions taken by the local server as a result of the reported situation.
      void setThreadId​(long threadId)
      Set up the identifier of the thread where the situation occurred.
      void setThreadName​(java.lang.String threadName)
      Set up he name of the thread where the situation occurred.
      void setTimeStamp​(java.util.Date timeStamp)
      Set up the time stamp for when the audit log record was created.
      void setUserAction​(java.lang.String userAction)
      Set up details of the actions (if any) that a user can take in response to the reported situation.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AuditLogRecord

        public AuditLogRecord()
        Default constructor
      • AuditLogRecord

        public AuditLogRecord​(AuditLogRecord template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getGUID

        public java.lang.String getGUID()
        Return the unique Id of the audit log record.
        Returns:
        String guid
      • setGUID

        public void setGUID​(java.lang.String guid)
        Set up the unique Id of the audit log record.
        Parameters:
        guid - String guid
      • getTimeStamp

        public java.util.Date getTimeStamp()
        Return the time stamp for when the audit log record was created.
        Returns:
        Date object
      • setTimeStamp

        public void setTimeStamp​(java.util.Date timeStamp)
        Set up the time stamp for when the audit log record was created.
        Parameters:
        timeStamp - Date object
      • getOriginatorProperties

        public java.util.Map<java.lang.String,​java.lang.String> getOriginatorProperties()
        Return details of the originator of the log record.
        Returns:
        map of name value pairs
      • setOriginatorProperties

        public void setOriginatorProperties​(java.util.Map<java.lang.String,​java.lang.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 java.lang.String getActionDescription()
        Return the description of the activity that this log record relates.
        Returns:
        string description
      • setActionDescription

        public void setActionDescription​(java.lang.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 java.lang.String getThreadName()
        Return the name of the thread where the situation occurred.
        Returns:
        string name
      • setThreadName

        public void setThreadName​(java.lang.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 java.lang.String getSeverity()
        Return the severity of the situation recorded in the log record.
        Returns:
        String severity
      • setSeverity

        public void setSeverity​(java.lang.String severity)
        Set up the severity of the situation recorded in the log record.
        Parameters:
        severity - String severity
      • getMessageId

        public java.lang.String getMessageId()
        Return the identifier of the message within the log record.
        Returns:
        String message id
      • setMessageId

        public void setMessageId​(java.lang.String messageId)
        Set up the identifier of the message within the log record.
        Parameters:
        messageId - String message id
      • getMessageText

        public java.lang.String getMessageText()
        Return the text of the message within the log record.
        Returns:
        String message text
      • setMessageText

        public void setMessageText​(java.lang.String messageText)
        Set up the text of the message within the log record.
        Parameters:
        messageText - String message text
      • getMessageParameters

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

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

        public java.util.List<java.lang.String> getAdditionalInformation()
        Return any additional information in the audit log record.
        Returns:
        List of String additional information
      • setAdditionalInformation

        public void setAdditionalInformation​(java.util.List<java.lang.String> additionalInformation)
        Set up any additional information in the audit log record.
        Parameters:
        additionalInformation - List of String additional information
      • getSystemAction

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getExceptionClassName()
        Return the name of any exception linked to the audit log record.
        Returns:
        the class name
      • setExceptionClassName

        public void setExceptionClassName​(java.lang.String exceptionClassName)
        Set up the name of any exception linked to the audit log record.
        Parameters:
        exceptionClassName - string name
      • getExceptionMessage

        public java.lang.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​(java.lang.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 java.lang.String getExceptionStackTrace()
        Return the stack trace associated with any exception linked to the audit log record.
        Returns:
        string stack trace
      • setExceptionStackTrace

        public void setExceptionStackTrace​(java.lang.String exceptionStackTrace)
        Set up the stack trace associated with any exception linked to the audit log record.
        Parameters:
        exceptionStackTrace - string stack trace
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        JSON style description of variables.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        in hash code