Package org.apereo.inspektr.audit

Interface AuditTrailManager

All Superinterfaces:
org.apereo.inspektr.common.Cleanable
All Known Implementing Classes:
AbstractStringAuditTrailManager, ConsoleAuditTrailManager, GroovyAuditTrailManager, Slf4jLoggingAuditTrailManager
public interface AuditTrailManager extends org.apereo.inspektr.common.Cleanable
An interface used to make an audit trail record.
Since:
1.0
Author:
Dmitriy Kopylenko

  • Field Details

    • LOG

      static final org.slf4j.Logger LOG

    • MAPPER

      static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

  • Method Details

    • toJson

      static String toJson(Object arg)

    • record

      void record(AuditActionContext auditActionContext)
      Make an audit trail record. Implementations could use any type of back end medium to serialize audit trail data i.e. RDBMS, log file, IO stream, SMTP, JMS queue or what ever else imaginable.

      This concept is somewhat similar to log4j Appender.

      Parameters:
      auditActionContext - the audit action context

    • getAuditRecords

      Set<? extends AuditActionContext> getAuditRecords(Map<AuditTrailManager.WhereClauseFields,Object> whereClause)
      Gets audit records since.
      Parameters:
      whereClause - the where clause
      Returns:
      the audit records since

    • removeAll

      default void removeAll()
      Remove all.

    • clean

      default void clean()
      Specified by:
      clean in interface org.apereo.inspektr.common.Cleanable

    • setAuditFormat

      default void setAuditFormat(AuditTrailManager.AuditFormats auditFormat)