org.apereo.inspektr.audit

Interface AuditTrailManager

All Superinterfaces:

Cleanable

All Known Implementing Classes:

AbstractStringAuditTrailManager, ConsoleAuditTrailManager, Slf4jLoggingAuditTrailManager

public interface AuditTrailManager
extends 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 and Description
static class	AuditTrailManager.AuditFormats

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG
static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Method Summary

Modifier and Type	Method and Description
default void	clean()
java.util.Set<? extends AuditActionContext>	getAuditRecordsSince(java.time.LocalDate sinceDate) Gets audit records since.
void	record(AuditActionContext auditActionContext) Make an audit trail record.
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

getAuditRecordsSince

java.util.Set<? extends AuditActionContext> getAuditRecordsSince(java.time.LocalDate sinceDate)

Gets audit records since.

Parameters:

sinceDate - the since date

Returns:

the audit records since

removeAll

void removeAll()

Remove all.

clean

default void clean()

Specified by:

clean in interface Cleanable

setAuditFormat

default void setAuditFormat(AuditTrailManager.AuditFormats auditFormat)