Package org.nuxeo.audit.service

Interface AuditBackend.CursorServiceScroll<C,O>

Type Parameters:

C - The cursor type, for instance Iterator

O - The object type, for instance LogEntry or third party type

All Superinterfaces:

AuditAdmin, AuditBackend, AuditBackend<LogEntry>, AuditLogger<LogEntry>, AuditReader<LogEntry>, Logs<LogEntry>

All Known Implementing Classes:

MemAuditBackend, MongoDBAuditBackend, OpenSearchAuditBackend

Enclosing interface:

AuditBackend

public static interface AuditBackend.CursorServiceScroll<C,O>
extends AuditBackend

Interface adding the cursor service capabilities to the audit backend. The cursor service is used to scroll large result sets of log entries

Since:

2025.18

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default void	clearScrollLogIds(String scrollId)
CursorService<C,O,String>	getCursorService()
default ScrollResult<String>	scrollLogIds(String scrollId)
default ScrollResult<String>	scrollLogIds(QueryBuilder builder, int batchSize, Duration keepAlive)
CursorResult<C,O>	scrollLogIdsAsCursor(QueryBuilder builder, int batchSize, Duration keepAlive)

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

syncLogCreationEntries

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

addLogEntries, getEventsCount, getLatestLogId, getLogEntriesFor, getLogEntryByID, hasCapability, insertLogs, queryLogs

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

getApplicationStartedOrder, onApplicationStarted, onApplicationStopped, restore

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, nativeQuery, nativeQueryLogs, queryLogs, queryLogsByPage, queryLogsByPage, queryLogsByPage, queryLogsByPage

Method Details

getCursorService

CursorService<C,O,String> getCursorService()

Returns:

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

scrollLogIdsAsCursor

CursorResult<C,O> scrollLogIdsAsCursor(QueryBuilder builder,
 int batchSize,
 Duration keepAlive)

scrollLogIds

default ScrollResult<String> scrollLogIds(QueryBuilder builder,
 int batchSize,
 Duration keepAlive)

Specified by:

scrollLogIds in interface AuditBackend

Parameters:

builder - the query builder to scroll log entry ids

batchSize - the size of batches to scroll

keepAlive - the scroll keep alive duration

Returns:

the scroll result

scrollLogIds

default ScrollResult<String> scrollLogIds(String scrollId)

Specified by:

scrollLogIds in interface AuditBackend

Parameters:

scrollId - the scroll id

Returns:

the scroll result

clearScrollLogIds

default void clearScrollLogIds(String scrollId)

Specified by:

clearScrollLogIds in interface AuditBackend

Parameters:

scrollId - the scroll id to clear