Package org.odpi.openmetadata.frameworks.auditlog

Class AuditLogReport

java.lang.Object
org.odpi.openmetadata.frameworks.auditlog.AuditLogReport
Direct Known Subclasses:
OMRSAuditLogReport
public class AuditLogReport extends Object
AuditLogReport is a container for returning information about a hierarchy of audit logs.

  • Constructor Details

    • AuditLogReport

      public AuditLogReport()
      Default constructor

    • AuditLogReport

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

  • Method Details

    • getReportingComponent

      public AuditLogReportingComponent getReportingComponent()
      Return the description of the component that is using this audit log.
      Returns:
      component id, name, description and doc URL

    • setReportingComponent

      public void setReportingComponent(AuditLogReportingComponent reportingComponent)
      Set up the description of the component that is using this audit log.
      Parameters:
      reportingComponent - component id, name, description and doc URL

    • getChildAuditLogReports

      public List<AuditLogReport> getChildAuditLogReports()
      Return the reports for the hierarchy of audit logs nested in this audit log.
      Returns:
      reports from hierarchy of child audit logs

    • setChildAuditLogReports

      public void setChildAuditLogReports(List<AuditLogReport> childAuditLogReports)
      Set up the reports for the hierarchy of audit logs nested in this audit log.
      Parameters:
      childAuditLogReports - reports from hierarchy of child audit logs

    • getSeverityIdentification

      public Map<Integer,List<String>> getSeverityIdentification()
      Return the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1. However, the audit log allows for components from different sources clashing on the severity code. The report helps an organization identify when this is occurring.
      Returns:
      map of severity codes to list of severity names associated with it.

    • setSeverityIdentification

      public void setSeverityIdentification(Map<Integer,List<String>> severityIdentification)
      Set up the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1. However, the audit log allows for components from different sources clashing on the severity code. The report helps an organization identify when this is occurring.
      Parameters:
      severityIdentification - map of severity codes to list of severity names associated with it.

    • getSeverityCount

      public Map<Integer,Integer> getSeverityCount()
      Return the count of log records for each severity code.
      Returns:
      map of severity code to log record count

    • setSeverityCount

      public void setSeverityCount(Map<Integer,Integer> severityCount)
      Set up the count of log records for each severity code.
      Parameters:
      severityCount - map of severity code to log record count

    • 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