Package org.nuxeo.audit.service

Class AbstractAuditBackend

java.lang.Object

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

org.nuxeo.audit.service.AbstractAuditBackend

All Implemented Interfaces:

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

Direct Known Subclasses:

MemAuditBackend, MongoDBAuditBackend, OpenSearchAuditBackend, SQLAuditBackend

public abstract class AbstractAuditBackend
extends AbstractAuditBackend<LogEntry>
implements AuditBackend

Abstract class to share code between AuditBackend implementations

Since:

2025.0

Nested Class Summary

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

AuditBackend.Capability

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.logging.log4j.Logger	log
protected String	name	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.16, introduced for addLogEntries(List) backward compatibility mechanism

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

component, config, expressionEvaluator, FORCE_AUDIT_FACET

Constructor Summary

Constructors

Constructor	Description
AbstractAuditBackend()

Method Summary

Modifier and Type	Method	Description
void	addLogEntries(List<LogEntry> entries)	Deprecated, for removal: This API element is subject to removal in a future version.
void	append(List<String> jsonEntries)
protected void	clearEntries()	INTERNAL METHOD FOR TESTS, DO NOT USE.
protected LogEntry	doCreateAndFillEntryFromDocument(DocumentModel doc, Principal principal)
int	getApplicationStartedOrder()	Deprecated, for removal: This API element is subject to removal in a future version.
ExtendedInfo	newExtendedInfo(Serializable value)	Deprecated, for removal: This API element is subject to removal in a future version.
void	onApplicationStarted()	Deprecated, for removal: This API element is subject to removal in a future version.
void	onApplicationStopped()	Deprecated, for removal: This API element is subject to removal in a future version.
ScrollResult<String>	scroll(String scrollId)
ScrollResult<String>	scroll(QueryBuilder queryBuilder, int batchSize, int keepAliveSeconds)
protected void	setName(String name)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.16
long	syncLogCreationEntries(String repoId, String path, Boolean recurs)	Deprecated, for removal: This API element is subject to removal in a future version.

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.audit.service.AuditBackend

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

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

restore

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

await, buildEntryFromEvent, getAuditableEventNames, newLogEntry

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

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

Field Details

log

protected static final org.apache.logging.log4j.Logger log

name

@Deprecated(since="2025.16",
            forRemoval=true)
protected String name

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.16, introduced for addLogEntries(List) backward compatibility mechanism

Constructor Details

AbstractAuditBackend

public AbstractAuditBackend()

Method Details

addLogEntries

@Deprecated(since="2025.16",
            forRemoval=true)
public void addLogEntries(List<LogEntry> entries)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuditBackend

Adds given log entries.

Specified by:

addLogEntries in interface AuditBackend

Specified by:

addLogEntries in interface AuditLogger<LogEntry>

Parameters:

entries - the list of log entries.

doCreateAndFillEntryFromDocument

protected LogEntry doCreateAndFillEntryFromDocument(DocumentModel doc,
 Principal principal)

Overrides:

doCreateAndFillEntryFromDocument in class AbstractAuditBackend<LogEntry>

clearEntries

protected void clearEntries()

INTERNAL METHOD FOR TESTS, DO NOT USE.

newExtendedInfo

@Deprecated(since="2025.0",
            forRemoval=true)
public ExtendedInfo newExtendedInfo(Serializable value)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuditLogger

Create a new ExtendedInfo instance

Specified by:

newExtendedInfo in interface AuditLogger<LogEntry>

Specified by:

newExtendedInfo in class AbstractAuditBackend<LogEntry>

getApplicationStartedOrder

@Deprecated(since="2025.0",
            forRemoval=true)
public int getApplicationStartedOrder()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getApplicationStartedOrder in interface AuditBackend<LogEntry>

onApplicationStarted

@Deprecated(since="2025.0",
            forRemoval=true)
public void onApplicationStarted()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

onApplicationStarted in interface AuditBackend<LogEntry>

onApplicationStopped

@Deprecated(since="2025.0",
            forRemoval=true)
public void onApplicationStopped()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

onApplicationStopped in interface AuditBackend<LogEntry>

syncLogCreationEntries

@Deprecated(since="2025.0",
            forRemoval=true)
public long syncLogCreationEntries(String repoId,
 String path,
 Boolean recurs)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AuditAdmin

Forces log Synchronisation for a branch of the repository. This can be useful to add the create entries if DB was initialized from a bulk import.

Specified by:

syncLogCreationEntries in interface AuditAdmin

append

public void append(List<String> jsonEntries)

Specified by:

append in interface AuditStorage

scroll

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

Specified by:

scroll in interface AuditStorage

scroll

public ScrollResult<String> scroll(String scrollId)

Specified by:

scroll in interface AuditStorage

setName

@Deprecated(since="2025.16",
            forRemoval=true)
protected void setName(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.16