Package org.nuxeo.ecm.platform.audit.api

Interface AuditLogger<L extends LogEntry>

Type Parameters:

L - to give the log entry type for the new AuditBackend interface that defines a new entry type.

All Known Subinterfaces:

AuditBackend, AuditBackend<L>, Logs<L>, LogsRemote

All Known Implementing Classes:

AbstractAuditBackend, AbstractAuditBackend, DefaultAuditBackend, MemAuditBackend, MongoDBAuditBackend, OpenSearchAuditBackend, SQLAuditBackend

@Deprecated(since="2025.0",
            forRemoval=true)
public interface AuditLogger<L extends LogEntry>

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

since 2025.0, use AuditBackend instead

Interface for adding audit logs.

Author:

tiry

Method Summary

Modifier and Type	Method	Description
void	addLogEntries(List<L> entries)	Deprecated, for removal: This API element is subject to removal in a future version. Adds given log entries.
boolean	await(long time, TimeUnit unit)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#await(Duration) instead
L	buildEntryFromEvent(Event event)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#buildEntryFromEvent() instead
Set<String>	getAuditableEventNames()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#getAuditableEventNames() instead
ExtendedInfo	newExtendedInfo(Serializable value)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use LogEntryBuilder.extended(String, Object) instead
L	newLogEntry()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use LogEntry.builder() instead

Method Details

getAuditableEventNames

@Deprecated(since="2025.0",
            forRemoval=true)
Set<String> getAuditableEventNames()

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

since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#getAuditableEventNames() instead

Returns the list of auditable event names.

Returns:

a set of String representing event names.

newLogEntry

@Deprecated(since="2025.0",
            forRemoval=true)
L newLogEntry()

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

since 2025.0, use LogEntry.builder() instead

Create a new LogEntry instance.

newExtendedInfo

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

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

since 2025.0, use LogEntryBuilder.extended(String, Object) instead

Create a new ExtendedInfo instance

addLogEntries

void addLogEntries(List<L> entries)

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

Adds given log entries.

Parameters:

entries - the list of log entries.

await

@Deprecated(since="2025.0",
            forRemoval=true)
boolean await(long time,
 TimeUnit unit)
       throws InterruptedException

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

since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#await(Duration) instead

Throws:

InterruptedException

Since:

8.2

buildEntryFromEvent

@Deprecated(since="2025.0",
            forRemoval=true)
L buildEntryFromEvent(Event event)

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

since 2025.0, use org.nuxeo.ecm.platform.audit.service.AuditService#buildEntryFromEvent() instead

Returns a log entry representation of an event.

Since:

9.3