Package org.nuxeo.audit.service

Class AuditComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.audit.service.AuditComponent

All Implemented Interfaces:

AuditRouter, AuditService, Adaptable, Component, Extensible, TimestampedService

public class AuditComponent
extends DefaultComponent
implements AuditRouter, AuditService

Since:

2025.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADAPTER_EXT_POINT
protected Map<String,AuditBackendFactory<?>>	auditBackendFactories
protected static final String	BACKEND_FACTORY_EXT_POINT
static final String	DEFAULT_AUDIT_BACKEND	The default audit backend name.
static final String	DISABLE_AUDIT_LOGGER	If passed as true on the event properties, event not logged
protected static final String	EVENT_EXT_POINT	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.16, use ROUTES_EXT_POINT instead
protected Map<String,List<ExtendedInfoMapper>>	eventExtendedInfoMappers
protected final ExpressionEvaluator	expressionEvaluator
protected static final String	EXTENDED_INFO_EXT_POINT
static final String	FORCE_AUDIT_FACET
protected Boolean	handleVirtualEvents
protected List<Route>	routes
protected static final String	ROUTES_EXT_POINT
protected static final String	SEQUENCE_NAME
static final String	STREAM_AUDIT_VIRTUAL_EVENTS_ENABLED_PROP
protected static final String	VIRTUAL_EVENT

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
AuditComponent()

Method Summary

Modifier and Type	Method	Description
boolean	await(Duration duration)	Awaits the audit ingestion.
LogEntry	buildEntryFromEvent(Event event)	Returns a log entry representation of an event.
protected void	clearEntriesFromBackends()	INTERNAL METHOD FOR TESTS, DO NOT USE.
List<LogEntry>	computeLogEntries(Event event)	Computes the log entries from the given event based on contributed audit routes.
protected void	doPutExtendedInfos(LogEntryBuilder builder, EventContext eventContext, DocumentModel source, Principal principal)
protected List<LogEntry>	extractVirtualEvents(Object[] args)
<T> T	getAdapter(Class<T> adapter)	Returns an object which is an instance of the given class associated with this object.
int	getApplicationStartedOrder()	The component notification order for Component.start(ComponentContext).
Set<String>	getAuditableEventNames()
<B extends AuditBackend> B	getAuditBackend(String name)
List<ExtendedInfoMapper>	getExtendedInfoMappers(String eventName)
AuditRouterIntrospection	getIntrospection()	Returns the audit router introspection to get information about the registered routes and backends.
protected boolean	handleVirtualEvents()
protected void	populateExtendedInfo(LogEntryBuilder builder, DocumentModel source, ExpressionContext context, List<ExtendedInfoMapper> mappers)
void	registerContribution(Object contribution, String xp, ComponentInstance component)	Deprecated, for removal: This API element is subject to removal in a future version.
void	routeToBackends(List<LogEntry> logEntries)	Routes the given log entries to the appropriate backends based on contributed live audit routes.
void	routeToBackends(List<LogEntry> logEntries, List<Route> routes)	Routes the given log entries to the appropriate backends based on given audit routes.
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	unregisterContribution(Object contribution, String xp, ComponentInstance component)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_AUDIT_BACKEND

public static final String DEFAULT_AUDIT_BACKEND

The default audit backend name.

See Also:

• Constant Field Values

DISABLE_AUDIT_LOGGER

public static final String DISABLE_AUDIT_LOGGER

If passed as true on the event properties, event not logged

See Also:

• Constant Field Values

FORCE_AUDIT_FACET

public static final String FORCE_AUDIT_FACET

See Also:

• Constant Field Values

STREAM_AUDIT_VIRTUAL_EVENTS_ENABLED_PROP

public static final String STREAM_AUDIT_VIRTUAL_EVENTS_ENABLED_PROP

Since:

2025.16

See Also:

• Constant Field Values

SEQUENCE_NAME

protected static final String SEQUENCE_NAME

See Also:

• Constant Field Values

VIRTUAL_EVENT

protected static final String VIRTUAL_EVENT

See Also:

• Constant Field Values

ADAPTER_EXT_POINT

protected static final String ADAPTER_EXT_POINT

See Also:

• Constant Field Values

BACKEND_FACTORY_EXT_POINT

protected static final String BACKEND_FACTORY_EXT_POINT

See Also:

• Constant Field Values

EVENT_EXT_POINT

@Deprecated(since="2025.16",
            forRemoval=true)
protected static final String EVENT_EXT_POINT

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

since 2025.16, use ROUTES_EXT_POINT instead

See Also:

• Constant Field Values

EXTENDED_INFO_EXT_POINT

protected static final String EXTENDED_INFO_EXT_POINT

See Also:

• Constant Field Values

ROUTES_EXT_POINT

protected static final String ROUTES_EXT_POINT

Since:

2025.16

See Also:

• Constant Field Values

expressionEvaluator

protected final ExpressionEvaluator expressionEvaluator

auditBackendFactories

protected Map<String,AuditBackendFactory<?>> auditBackendFactories

eventExtendedInfoMappers

protected Map<String,List<ExtendedInfoMapper>> eventExtendedInfoMappers

routes

protected List<Route> routes

Since:

2025.16

handleVirtualEvents

protected Boolean handleVirtualEvents

Constructor Details

AuditComponent

public AuditComponent()

Method Details

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

registerContribution

@Deprecated(since="2025.16",
            forRemoval=true)
public void registerContribution(Object contribution,
 String xp,
 ComponentInstance component)

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

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

@Deprecated(since="2025.16",
            forRemoval=true)
public void unregisterContribution(Object contribution,
 String xp,
 ComponentInstance component)

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

Overrides:

unregisterContribution in class DefaultComponent

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.start(ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)
          throws InterruptedException

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

Throws:

InterruptedException

computeLogEntries

public List<LogEntry> computeLogEntries(Event event)

Description copied from interface: AuditRouter

Computes the log entries from the given event based on contributed audit routes.

Specified by:

computeLogEntries in interface AuditRouter

Parameters:

event - the event to compute log entries from

Returns:

the log entries to route, it could be an empty list if the event doesn't match any route

Since:

2025.16

handleVirtualEvents

protected boolean handleVirtualEvents()

extractVirtualEvents

protected List<LogEntry> extractVirtualEvents(Object[] args)

routeToBackends

public void routeToBackends(List<LogEntry> logEntries)

Description copied from interface: AuditRouter

Routes the given log entries to the appropriate backends based on contributed live audit routes.

Specified by:

routeToBackends in interface AuditRouter

Parameters:

logEntries - the log entries to route

routeToBackends

public void routeToBackends(List<LogEntry> logEntries,
 List<Route> routes)

Description copied from interface: AuditRouter

Routes the given log entries to the appropriate backends based on given audit routes.

Each given route will be evaluated and log entry routed if it matches.

Specified by:

routeToBackends in interface AuditRouter

Parameters:

logEntries - the log entries to route

routes - the routes to evaluate on log entries

getIntrospection

public AuditRouterIntrospection getIntrospection()

Description copied from interface: AuditRouter

Returns the audit router introspection to get information about the registered routes and backends.

Specified by:

getIntrospection in interface AuditRouter

Returns:

the audit router introspection

getAuditableEventNames

public Set<String> getAuditableEventNames()

Specified by:

getAuditableEventNames in interface AuditService

Returns:

the event names to write to the audit

getExtendedInfoMappers

public List<ExtendedInfoMapper> getExtendedInfoMappers(String eventName)

Specified by:

getExtendedInfoMappers in interface AuditService

Parameters:

eventName - the event name to write to the audit

Returns:

the extended info mappers to apply when writing to the audit

getAuditBackend

public <B extends AuditBackend> B getAuditBackend(String name)

Specified by:

getAuditBackend in interface AuditService

Returns:

the AuditBackend with the given name

buildEntryFromEvent

@Nullable
public LogEntry buildEntryFromEvent(Event event)

Description copied from interface: AuditService

Returns a log entry representation of an event.

Specified by:

buildEntryFromEvent in interface AuditService

doPutExtendedInfos

protected void doPutExtendedInfos(LogEntryBuilder builder,
 EventContext eventContext,
 DocumentModel source,
 Principal principal)

populateExtendedInfo

protected void populateExtendedInfo(LogEntryBuilder builder,
 DocumentModel source,
 ExpressionContext context,
 List<ExtendedInfoMapper> mappers)

await

public boolean await(Duration duration)
              throws InterruptedException

Description copied from interface: AuditService

Awaits the audit ingestion.

Specified by:

await in interface AuditService

Throws:

InterruptedException

clearEntriesFromBackends

protected void clearEntriesFromBackends()

INTERNAL METHOD FOR TESTS, DO NOT USE.