Package org.nuxeo.audit.sql

Class SQLAuditBackend

java.lang.Object

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

org.nuxeo.audit.service.AbstractAuditBackend

org.nuxeo.audit.sql.SQLAuditBackend

All Implemented Interfaces:

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

public class SQLAuditBackend
extends AbstractAuditBackend

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 final DefaultAuditBackend	backend
protected static final LogEntryImplToLogEntry	FROM_LOG_ENTRY_SQL_MAPPER
protected static final LogEntryToLogEntryImpl	TO_LOG_ENTRY_SQL_MAPPER

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

log

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

component, config, expressionEvaluator, FORCE_AUDIT_FACET

Constructor Summary

Constructors

Constructor	Description
SQLAuditBackend()

Method Summary

Modifier and Type	Method	Description
void	addLogEntries(List<LogEntry> entries)	Adds given log entries.
void	append(List<String> jsonEntries)
protected void	clearEntries()	INTERNAL METHOD FOR TESTS, DO NOT USE.
protected void	doClearEntries()
int	getApplicationStartedOrder()
Long	getEventsCount(String eventId)
LogEntry	getLogEntryByID(long id)	Returns a given log entry given its id.
List<String>	getLoggedEventIds()
boolean	hasCapability(AuditBackend.Capability capability)	Checks whether the backend has the capability.
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize)	Returns a batched list of entries.
List<LogEntry>	nativeQueryLogs(String whereClause, int pageNb, int pageSize)	Returns a batched list of log entries.
ExtendedInfo	newExtendedInfo(Serializable value)	Create a new ExtendedInfo instance
void	onApplicationStarted()
void	onApplicationStopped()
LogEntryList	queryLogs(QueryBuilder builder)	Returns the logs given a collection of predicates and a default sort.
ScrollResult<String>	scroll(String scrollId)
ScrollResult<String>	scroll(QueryBuilder queryBuilder, int batchSize, int keepAliveSeconds)
long	syncLogCreationEntries(String repoId, String path, Boolean recurs)	Forces log Synchronisation for a branch of the repository.

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

doCreateAndFillEntryFromDocument

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

getLatestLogId, getLogEntriesFor

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

Field Details

FROM_LOG_ENTRY_SQL_MAPPER

protected static final LogEntryImplToLogEntry FROM_LOG_ENTRY_SQL_MAPPER

TO_LOG_ENTRY_SQL_MAPPER

protected static final LogEntryToLogEntryImpl TO_LOG_ENTRY_SQL_MAPPER

backend

protected final DefaultAuditBackend backend

Constructor Details

SQLAuditBackend

public SQLAuditBackend()

Method Details

newExtendedInfo

public ExtendedInfo newExtendedInfo(Serializable value)

Description copied from interface: AuditLogger

Create a new ExtendedInfo instance

Specified by:

newExtendedInfo in interface AuditLogger<LogEntry>

Overrides:

newExtendedInfo in class AbstractAuditBackend

addLogEntries

public void addLogEntries(List<LogEntry> entries)

Description copied from interface: AuditBackend

Adds given log entries.

Parameters:

entries - the list of log entries.

append

public void append(List<String> jsonEntries)

Specified by:

append in interface AuditStorage

Overrides:

append in class AbstractAuditBackend

scroll

public ScrollResult<String> scroll(QueryBuilder queryBuilder,
 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

getApplicationStartedOrder

public int getApplicationStartedOrder()

Specified by:

getApplicationStartedOrder in interface AuditBackend<LogEntry>

Overrides:

getApplicationStartedOrder in class AbstractAuditBackend

onApplicationStarted

public void onApplicationStarted()

Specified by:

onApplicationStarted in interface AuditBackend<LogEntry>

Overrides:

onApplicationStarted in class AbstractAuditBackend

onApplicationStopped

public void onApplicationStopped()

Specified by:

onApplicationStopped in interface AuditBackend<LogEntry>

Overrides:

onApplicationStopped in class AbstractAuditBackend

syncLogCreationEntries

public long syncLogCreationEntries(String repoId,
 String path,
 Boolean recurs)

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

Overrides:

syncLogCreationEntries in class AbstractAuditBackend

getEventsCount

public Long getEventsCount(String eventId)

getLogEntryByID

public LogEntry getLogEntryByID(long id)

Description copied from interface: AuditBackend

Returns a given log entry given its id.

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.

Parameters:

builder - the query builder to fetch log entries

Returns:

a list of log entries

hasCapability

public boolean hasCapability(AuditBackend.Capability capability)

Description copied from interface: AuditBackend

Checks whether the backend has the capability.

nativeQueryLogs

public List<LogEntry> nativeQueryLogs(String whereClause,
 int pageNb,
 int pageSize)

Description copied from interface: AuditReader

Returns a batched list of log entries. WhereClause is a native where clause for the backend: here EJBQL 3.0 must be used if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch.

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.

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

doClearEntries

protected void doClearEntries()

getLoggedEventIds

public List<String> getLoggedEventIds()