Package org.nuxeo.ecm.platform.audit.service

Class NXAuditEventsService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.audit.service.NXAuditEventsService

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService

public class NXAuditEventsService
extends DefaultComponent

Event service configuration.

Author:

Julien Anguenot

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,AuditStorageDescriptor>	auditStorageDescriptors
protected Map<String,AuditStorage>	auditStorages
protected AuditBackend	backend
protected AuditBackendDescriptor	backendConfig
protected AuditBulker	bulker	Deprecated. since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
protected AuditBulkerDescriptor	bulkerConfig	Deprecated. since 10.10, audit bulker is now handled with nuxeo-stream, no replacement
static final String	DISABLE_AUDIT_LOGGER	If passed as true on the event properties, event not logged
protected final Set<AdapterDescriptor>	documentAdapters
protected final Map<String,List<ExtendedInfoDescriptor>>	eventExtendedInfoDescriptors
protected final Set<String>	eventNames
protected final Set<ExtendedInfoDescriptor>	extendedInfoDescriptors
protected static final org.apache.logging.log4j.Logger	log
static final ComponentName	NAME

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

lastModified, name

Constructor Summary

Constructors

Constructor	Description
NXAuditEventsService()

Method Summary

Modifier and Type	Method	Description
protected void	doRegisterAdapter(AdapterDescriptor desc)
protected void	doRegisterEvent(EventDescriptor desc)
protected void	doRegisterExtendedInfo(ExtendedInfoDescriptor desc)
protected void	doUnregisterAdapter(AdapterDescriptor desc)
protected void	doUnregisterEvent(EventDescriptor desc)
protected void	doUnregisterExtendedInfo(ExtendedInfoDescriptor desc)
<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()
AuditStorage	getAuditStorage(String id)
AuditBackend	getBackend()
Set<AdapterDescriptor>	getDocumentAdapters()
Map<String,List<ExtendedInfoDescriptor>>	getEventExtendedInfoDescriptors()
Set<ExtendedInfoDescriptor>	getExtendedInfoDescriptors()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

NAME

public static final ComponentName NAME

DISABLE_AUDIT_LOGGER

public static final String DISABLE_AUDIT_LOGGER

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

Since:

5.7

See Also:

• Constant Field Values

log

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

extendedInfoDescriptors

protected final Set<ExtendedInfoDescriptor> extendedInfoDescriptors

eventExtendedInfoDescriptors

protected final Map<String,List<ExtendedInfoDescriptor>> eventExtendedInfoDescriptors

documentAdapters

protected final Set<AdapterDescriptor> documentAdapters

eventNames

protected final Set<String> eventNames

backend

protected AuditBackend backend

backendConfig

protected AuditBackendDescriptor backendConfig

bulker

@Deprecated
protected AuditBulker bulker

Deprecated.

since 10.10, audit bulker is now handled with nuxeo-stream, no replacement

bulkerConfig

@Deprecated
protected AuditBulkerDescriptor bulkerConfig

Deprecated.

since 10.10, audit bulker is now handled with nuxeo-stream, no replacement

auditStorageDescriptors

protected Map<String,AuditStorageDescriptor> auditStorageDescriptors

auditStorages

protected Map<String,AuditStorage> auditStorages

Constructor Details

NXAuditEventsService

public NXAuditEventsService()

Method Details

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.

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)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

doRegisterAdapter

protected void doRegisterAdapter(AdapterDescriptor desc)

doRegisterEvent

protected void doRegisterEvent(EventDescriptor desc)

doRegisterExtendedInfo

protected void doRegisterExtendedInfo(ExtendedInfoDescriptor desc)

doUnregisterAdapter

protected void doUnregisterAdapter(AdapterDescriptor desc)

doUnregisterEvent

protected void doUnregisterEvent(EventDescriptor desc)

doUnregisterExtendedInfo

protected void doUnregisterExtendedInfo(ExtendedInfoDescriptor desc)

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

getAuditableEventNames

public Set<String> getAuditableEventNames()

getBackend

public AuditBackend getBackend()

getDocumentAdapters

public Set<AdapterDescriptor> getDocumentAdapters()

getEventExtendedInfoDescriptors

public Map<String,List<ExtendedInfoDescriptor>> getEventExtendedInfoDescriptors()

Since:

7.4

getExtendedInfoDescriptors

public Set<ExtendedInfoDescriptor> getExtendedInfoDescriptors()

registerContribution

public void registerContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getAuditStorage

public AuditStorage getAuditStorage(String id)

Since:

9.3