Package org.nuxeo.audit.mem

Class MemAuditBackend

java.lang.Object

org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend<LogEntry>

org.nuxeo.audit.service.AbstractAuditBackend

org.nuxeo.audit.mem.MemAuditBackend

All Implemented Interfaces:

AuditBackend, AuditBackend.CursorServiceScroll<Iterator<LogEntry>,LogEntry>, AuditAdmin, AuditLogger<LogEntry>, AuditReader<LogEntry>, AuditStorage, Logs<LogEntry>, AuditBackend<LogEntry>

public class MemAuditBackend
extends AbstractAuditBackend
implements AuditBackend.CursorServiceScroll<Iterator<LogEntry>,LogEntry>

Since:

2025.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.audit.service.AuditBackend

AuditBackend.Capability, AuditBackend.CursorServiceScroll<C,O>

Field Summary

Fields

Modifier and Type	Field	Description
protected final CursorService<Iterator<LogEntry>,LogEntry,String>	cursorService
protected final org.apache.commons.collections4.queue.CircularFifoQueue<LogEntry>	entries
protected static final com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Fields inherited from class org.nuxeo.audit.service.AbstractAuditBackend

log, name

Fields inherited from class org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend

component, config, expressionEvaluator, FORCE_AUDIT_FACET

Constructor Summary

Constructors

Constructor	Description
MemAuditBackend()

Method Summary

Modifier and Type	Method	Description
protected void	clearEntries()	INTERNAL METHOD FOR TESTS, DO NOT USE.
protected int	compare(Object leftValue, Object rightValue)
protected Object	convertToLiteralsJavaType(Object leftValue)
protected Comparator<LogEntry>	createComparator(OrderByExpr queryOrder)
protected Comparator<LogEntry>	createComparator(OrderByList queryOrders)
protected Predicate<LogEntry>	createPredicate(Predicate queryPredicate)
CursorService<Iterator<LogEntry>,LogEntry,String>	getCursorService()
Long	getEventsCount(String eventId)
LogEntry	getLogEntryByID(long id)	Returns a given log entry given its id.
boolean	hasCapability(AuditBackend.Capability capability)	Checks whether the backend has the capability.
void	insertLogs(Collection<LogEntry> entries)	Inserts the given log entries into the backend.
protected Map<String,Object>	mapJsonContent(Map<String,Object> extended)
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize)	Returns a batched list of entries.
LogEntryList	queryLogs(QueryBuilder builder)	Returns the logs given a collection of predicates and a default sort.
CursorResult<Iterator<LogEntry>,LogEntry>	scrollLogIdsAsCursor(QueryBuilder builder, int batchSize, Duration keepAlive)

Methods inherited from class org.nuxeo.audit.service.AbstractAuditBackend

addLogEntries, append, doCreateAndFillEntryFromDocument, getApplicationStartedOrder, newExtendedInfo, onApplicationStarted, onApplicationStopped, scroll, scroll, setName, syncLogCreationEntries

Methods inherited from class org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend

await, buildEntryFromEvent, doPutExtendedInfos, doSyncNode, getAuditableEventNames, guardedDocument, guardedDocumentChildren, isAuditable, newLogEntry, populateExtendedInfo, restore, syncLogCreationEntries

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditAdmin

syncLogCreationEntries

Methods inherited from interface org.nuxeo.audit.service.AuditBackend

addLogEntries, getLatestLogId, getLogEntriesFor

Methods inherited from interface org.nuxeo.ecm.platform.audit.service.AuditBackend

getApplicationStartedOrder, onApplicationStarted, onApplicationStopped, restore

Methods inherited from interface org.nuxeo.audit.service.AuditBackend.CursorServiceScroll

clearScrollLogIds, scrollLogIds, scrollLogIds

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditLogger

await, buildEntryFromEvent, getAuditableEventNames, newExtendedInfo, newLogEntry

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditReader

getLogEntriesAfter, nativeQuery, nativeQueryLogs, queryLogs, queryLogsByPage, queryLogsByPage, queryLogsByPage, queryLogsByPage

Field Details

MAPPER

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

entries

protected final org.apache.commons.collections4.queue.CircularFifoQueue<LogEntry> entries

cursorService

protected final CursorService<Iterator<LogEntry>,LogEntry,String> cursorService

Constructor Details

MemAuditBackend

public MemAuditBackend()

Method Details

getEventsCount

public Long getEventsCount(String eventId)

Specified by:

getEventsCount in interface AuditAdmin

Specified by:

getEventsCount in interface AuditBackend

insertLogs

public void insertLogs(Collection<LogEntry> entries)

Description copied from interface: AuditBackend

Inserts the given log entries into the backend.

Specified by:

insertLogs in interface AuditBackend

Parameters:

entries - the list of log entries

mapJsonContent

protected Map<String,Object> mapJsonContent(Map<String,Object> extended)

getLogEntryByID

public LogEntry getLogEntryByID(long id)

Description copied from interface: AuditBackend

Returns a given log entry given its id.

Specified by:

getLogEntryByID in interface AuditBackend

Specified by:

getLogEntryByID in interface AuditReader<LogEntry>

Parameters:

id - the log entry identifier

Returns:

a LogEntry instance

queryLogs

public LogEntryList queryLogs(QueryBuilder builder)

Description copied from interface: AuditBackend

Returns the logs given a collection of predicates and a default sort.

Specified by:

queryLogs in interface AuditBackend

Specified by:

queryLogs in interface AuditReader<LogEntry>

Parameters:

builder - the query builder to fetch log entries

Returns:

a list of log entries

scrollLogIdsAsCursor

public CursorResult<Iterator<LogEntry>,LogEntry> scrollLogIdsAsCursor(QueryBuilder builder,
 int batchSize,
 Duration keepAlive)

Specified by:

scrollLogIdsAsCursor in interface AuditBackend.CursorServiceScroll<Iterator<LogEntry>,LogEntry>

Since:

2025.18

createPredicate

protected Predicate<LogEntry> createPredicate(Predicate queryPredicate)

compare

protected int compare(Object leftValue,
 Object rightValue)

convertToLiteralsJavaType

protected Object convertToLiteralsJavaType(Object leftValue)

createComparator

protected Comparator<LogEntry> createComparator(OrderByList queryOrders)

createComparator

protected Comparator<LogEntry> createComparator(OrderByExpr queryOrder)

hasCapability

public boolean hasCapability(AuditBackend.Capability capability)

Description copied from interface: AuditBackend

Checks whether the backend has the capability.

Specified by:

hasCapability in interface AuditBackend

getCursorService

public CursorService<Iterator<LogEntry>,LogEntry,String> getCursorService()

Specified by:

getCursorService in interface AuditBackend.CursorServiceScroll<Iterator<LogEntry>,LogEntry>

Returns:

the CursorService to use when scrolling elements, the service must be a singleton

nativeQuery

public List<?> nativeQuery(String query,
 Map<String,Object> params,
 int pageNb,
 int pageSize)

Description copied from interface: AuditReader

Returns a batched list of entries.

Specified by:

nativeQuery in interface AuditReader<LogEntry>

Parameters:

query - a JPA query language query if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch

params - parameters for the query

pageNb - the page number (starts at 1)

pageSize - the number of results per page

clearEntries

protected void clearEntries()

Description copied from class: AbstractAuditBackend

INTERNAL METHOD FOR TESTS, DO NOT USE.

Overrides:

clearEntries in class AbstractAuditBackend