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:

NXAuditEvents, Adaptable, Component, Extensible

public class NXAuditEventsService
extends DefaultComponent
implements NXAuditEvents

Event service configuration.

Author:

Julien Anguenot

Field Summary

static ComponentName

NAME

Constructor Summary

NXAuditEventsService()

Method Summary

LogEntry	computeLogEntry(DocumentMessage doc) Computes a log entry given a document message instance.
Set<String>	getAuditableEventNames() Returns the list of auditable event names.
LogEntryFactory	getLogEntryFactory() Returns a log entry factory instance.
Class<LogEntryFactory>	getLogEntryFactoryKlass() Returns the log entry factory class.
void	registerExtension(Extension extension) Registers the given extension.
void	unregisterExtension(Extension extension) Unregisters the given extension.

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

activate, deactivate, getAdapter, registerContribution, unregisterContribution

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

Constructor Detail

NXAuditEventsService

public NXAuditEventsService()

Method Detail

getAuditableEventNames

public Set<String> getAuditableEventNames()

Description copied from interface: NXAuditEvents

Returns the list of auditable event names.

Specified by:

getAuditableEventNames in interface NXAuditEvents

Returns:

list of String representing event names.

registerExtension

public void registerExtension(Extension extension)
                       throws Exception

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

Throws:

Exception - if any error occurs

unregisterExtension

public void unregisterExtension(Extension extension)
                         throws Exception

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

Throws:

Exception - if any error occurs

getLogEntryFactoryKlass

public Class<LogEntryFactory> getLogEntryFactoryKlass()

Description copied from interface: NXAuditEvents

Returns the log entry factory class.

Specified by:

getLogEntryFactoryKlass in interface NXAuditEvents

Returns:

a LogEntryFactory class

computeLogEntry

public LogEntry computeLogEntry(DocumentMessage doc)

Description copied from interface: NXAuditEvents

Computes a log entry given a document message instance.

Specified by:

computeLogEntry in interface NXAuditEvents

Parameters:

doc - : the document message instance.

Returns:

a log entry instance.

getLogEntryFactory

public LogEntryFactory getLogEntryFactory()

Description copied from interface: NXAuditEvents

Returns a log entry factory instance.

Specified by:

getLogEntryFactory in interface NXAuditEvents

Returns:

a LogEntryFactory instance.