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 and Description
protected AuditBackend	backend
static String	DISABLE_AUDIT_LOGGER If passed as true on the event properties, event not logged
protected Set<AdapterDescriptor>	documentAdapters
protected Map<String,List<ExtendedInfoDescriptor>>	eventExtendedInfoDescriptors
protected Set<String>	eventNames
protected Set<ExtendedInfoDescriptor>	extendedInfoDescriptors
protected static org.apache.commons.logging.Log	log
static ComponentName	NAME

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

lastModified

Constructor Summary

Constructors

Constructor and Description
NXAuditEventsService()

Method Summary

Modifier and Type	Method and Description
void	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
void	deactivate(ComponentContext context) Deactivates the component.
protected void	doRegisterAdapter(AdapterDescriptor desc)
protected void	doRegisterBackend(AuditBackendDescriptor 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.
Set<String>	getAuditableEventNames()
AuditBackend	getBackend()
Set<AdapterDescriptor>	getDocumentAdapters()
Map<String,List<ExtendedInfoDescriptor>>	getEventExtendedInfoDescriptors()
Set<ExtendedInfoDescriptor>	getExtendedInfoDescriptors()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

activate, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

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.commons.logging.Log 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

Constructor Detail

NXAuditEventsService

public NXAuditEventsService()

Method Detail

applicationStarted

public void applicationStarted(ComponentContext context)

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.

Specified by:

applicationStarted in interface Component

Overrides:

applicationStarted in class DefaultComponent

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

doRegisterAdapter

protected void doRegisterAdapter(AdapterDescriptor desc)

doRegisterBackend

protected void doRegisterBackend(AuditBackendDescriptor 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