org.nuxeo.ecm.platform.audit.api

Interface AuditLogger

All Known Subinterfaces:

AuditBackend, Logs, LogsRemote

All Known Implementing Classes:

AbstractAuditBackend, DefaultAuditBackend, ESAuditBackend, MongoDBAuditBackend

public interface AuditLogger

Interface for adding audit logs.

Author:

tiry

Method Summary

Modifier and Type	Method and Description
void	addLogEntries(List<LogEntry> entries) Adds given log entries.
boolean	await(long time, TimeUnit unit)
LogEntry	buildEntryFromEvent(Event event) Returns a log entry representation of an event.
Set<String>	getAuditableEventNames() Returns the list of auditable event names.
void	logEvent(Event event) Deprecated. since 10.10, audit event is now handled with nuxeo-stream, if you want to log events, contribute to NXAuditEventsService#event extension point
void	logEvents(EventBundle eventBundle) Deprecated. since 10.10, audit event is now handled with nuxeo-stream, if you want to log events, contribute to NXAuditEventsService#event extension point
ExtendedInfo	newExtendedInfo(Serializable value) Create a new ExtendedInfo instance
LogEntry	newLogEntry() Create a new LogEntry instance.

Method Detail

getAuditableEventNames

Set<String> getAuditableEventNames()

Returns the list of auditable event names.

Returns:

list of String representing event names.

newLogEntry

LogEntry newLogEntry()

Create a new LogEntry instance.

newExtendedInfo

ExtendedInfo newExtendedInfo(Serializable value)

Create a new ExtendedInfo instance

addLogEntries

void addLogEntries(List<LogEntry> entries)

Adds given log entries.

Parameters:

entries - the list of log entries.

logEvent

@Deprecated
void logEvent(Event event)

Deprecated. since 10.10, audit event is now handled with nuxeo-stream, if you want to log events, contribute to NXAuditEventsService#event extension point

Logs an Event.

logEvents

@Deprecated
void logEvents(EventBundle eventBundle)

Deprecated. since 10.10, audit event is now handled with nuxeo-stream, if you want to log events, contribute to NXAuditEventsService#event extension point

Logs a bundle of events

await

boolean await(long time,
              TimeUnit unit)
       throws InterruptedException

Throws:

InterruptedException

Since:

8.2

buildEntryFromEvent

LogEntry buildEntryFromEvent(Event event)

Returns a log entry representation of an event.

Since:

9.3