AuditTrailManager (Inspektr - Auditing API 1.8.20.GA API)

All Superinterfaces:

org.apereo.inspektr.common.Cleanable

All Known Implementing Classes:

AbstractStringAuditTrailManager, ConsoleAuditTrailManager, 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

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class AuditTrailManager.AuditFormats

static class AuditTrailManager.WhereClauseFields

Field Summary

Fields
Modifier and Type Field Description

static org.slf4j.Logger LOG

static com.fasterxml.jackson.databind.ObjectMapper MAPPER

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`clean()`
`java.util.Set<? extends AuditActionContext>`	`getAuditRecords(java.util.Map<AuditTrailManager.WhereClauseFields,java.lang.Object> whereClause)`	Gets audit records since.
`void`	`record(AuditActionContext auditActionContext)`	Make an audit trail record.
`default void`	`removeAll()`	Remove all.
`default void`	`setAuditFormat(AuditTrailManager.AuditFormats auditFormat)`
`static java.lang.String`	`toJson(java.lang.Object arg)`

- Field Detail
  - LOG
```
static final org.slf4j.Logger LOG
```
  - MAPPER
```
static final com.fasterxml.jackson.databind.ObjectMapper MAPPER
```
- Method Detail
  - toJson
```
static java.lang.String toJson(java.lang.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
```
java.util.Set<? extends AuditActionContext> getAuditRecords(java.util.Map<AuditTrailManager.WhereClauseFields,java.lang.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)
```