Package org.nuxeo.audit.mongodb

Class MongoDBAuditBackend

java.lang.Object

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

org.nuxeo.audit.service.AbstractAuditBackend

org.nuxeo.audit.mongodb.MongoDBAuditBackend

All Implemented Interfaces:

AuditBackend, AuditBackend.CursorServiceScroll<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document>, AuditAdmin, AuditLogger<LogEntry>, AuditReader<LogEntry>, AuditStorage, Logs<LogEntry>, AuditBackend<LogEntry>

public class MongoDBAuditBackend
extends AbstractAuditBackend
implements AuditBackend.CursorServiceScroll<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document>

Implementation of the AuditBackend interface using MongoDB persistence.

Since:

9.1

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 com.mongodb.client.MongoCollection<org.bson.Document>	collection
protected final CursorService<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,String>	cursorService
static final String	SEQ_NAME
protected final CursorService<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,String>	storageCursorService

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

name

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

component, config, expressionEvaluator, FORCE_AUDIT_FACET

Constructor Summary

Constructors

Constructor	Description
MongoDBAuditBackend(com.mongodb.client.MongoCollection<org.bson.Document> collection)

Method Summary

Modifier and Type	Method	Description
void	append(List<String> jsonEntries)
org.bson.conversions.Bson	buildFilter(String query, Map<String,Object> params)
protected void	clearEntries()	INTERNAL METHOD FOR TESTS, DO NOT USE.
String	expandQueryVariables(String query, Object[] params)
String	expandQueryVariables(String query, Map<String,Object> params)
com.mongodb.client.MongoCollection<org.bson.Document>	getAuditCollection()
CursorService<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,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.
protected static void	initUIDSequencer(com.mongodb.client.MongoCollection<org.bson.Document> collection)	Ensures the audit sequence returns an UID greater or equal than the maximum log entry id.
void	insertLogs(Collection<LogEntry> entries)	Inserts the given log entries into the backend.
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize)	Returns a batched list of entries.
LogEntryList	queryLogs(QueryBuilder query)	Returns the logs given a collection of predicates and a default sort.
ScrollResult<String>	scroll(String scrollId)
ScrollResult<String>	scroll(QueryBuilder query, int batchSize, int keepAliveSeconds)
CursorResult<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document>	scrollLogIdsAsCursor(QueryBuilder query, int batchSize, Duration keepAlive)

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

addLogEntries, doCreateAndFillEntryFromDocument, getApplicationStartedOrder, newExtendedInfo, onApplicationStarted, onApplicationStopped, 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

SEQ_NAME

public static final String SEQ_NAME

See Also:

• Constant Field Values

collection

protected final com.mongodb.client.MongoCollection<org.bson.Document> collection

cursorService

protected final CursorService<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,String> cursorService

storageCursorService

protected final CursorService<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,String> storageCursorService

Constructor Details

MongoDBAuditBackend

public MongoDBAuditBackend(com.mongodb.client.MongoCollection<org.bson.Document> collection)

Since:

2025.0

Method Details

getAuditCollection

public com.mongodb.client.MongoCollection<org.bson.Document> getAuditCollection()

Returns:

the MongoCollection configured with audit settings.

initUIDSequencer

protected static void initUIDSequencer(com.mongodb.client.MongoCollection<org.bson.Document> collection)

Ensures the audit sequence returns an UID greater or equal than the maximum log entry id.

queryLogs

public LogEntryList queryLogs(QueryBuilder query)

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:

query - the query builder to fetch log entries

Returns:

a list of log entries

scrollLogIdsAsCursor

public CursorResult<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document> scrollLogIdsAsCursor(QueryBuilder query,
 int batchSize,
 Duration keepAlive)

Specified by:

scrollLogIdsAsCursor in interface AuditBackend.CursorServiceScroll<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document>

Since:

2025.18

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

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

buildFilter

public org.bson.conversions.Bson buildFilter(String query,
 Map<String,Object> params)

expandQueryVariables

public String expandQueryVariables(String query,
 Object[] params)

expandQueryVariables

public String expandQueryVariables(String query,
 Map<String,Object> params)

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

getEventsCount

public Long getEventsCount(String eventId)

Specified by:

getEventsCount in interface AuditAdmin

Specified by:

getEventsCount in interface AuditBackend

append

public void append(List<String> jsonEntries)

Specified by:

append in interface AuditStorage

Overrides:

append in class AbstractAuditBackend

scroll

public ScrollResult<String> scroll(QueryBuilder query,
 int batchSize,
 int keepAliveSeconds)

Specified by:

scroll in interface AuditStorage

Overrides:

scroll in class AbstractAuditBackend

scroll

public ScrollResult<String> scroll(String scrollId)

Specified by:

scroll in interface AuditStorage

Overrides:

scroll in class AbstractAuditBackend

clearEntries

protected void clearEntries()

Description copied from class: AbstractAuditBackend

INTERNAL METHOD FOR TESTS, DO NOT USE.

Overrides:

clearEntries in class AbstractAuditBackend

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<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document,String> getCursorService()

Specified by:

getCursorService in interface AuditBackend.CursorServiceScroll<com.mongodb.client.MongoCursor<org.bson.Document>,org.bson.Document>

Returns:

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