org.nuxeo.ecm.platform.audit.service

Class AbstractAuditBackend

java.lang.Object

org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend

All Implemented Interfaces:

AuditAdmin, AuditLogger, AuditReader, Logs, AuditBackend

Direct Known Subclasses:

DefaultAuditBackend, ESAuditBackend

public abstract class AbstractAuditBackend
extends Object
implements AuditBackend

Abstract class to share code between AuditBackend implementations

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected NXAuditEventsService	component
protected AuditBackendDescriptor	config
protected ExpressionEvaluator	expressionEvaluator
static String	FORCE_AUDIT_FACET
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAuditBackend(NXAuditEventsService component, AuditBackendDescriptor config)

Method Summary

Modifier and Type	Method and Description
boolean	await(long time, TimeUnit unit)
protected LogEntry	buildEntryFromEvent(Event event)
protected LogEntry	doCreateAndFillEntryFromDocument(DocumentModel doc, Principal principal)
protected void	doPutExtendedInfos(LogEntry entry, EventContext eventContext, DocumentModel source, Principal principal)
protected long	doSyncNode(BaseLogEntryProvider provider, CoreSession session, DocumentModel node, boolean recurs)
Set<String>	getAuditableEventNames() Returns the list of auditable event names.
List<LogEntry>	getLogEntriesFor(String uuid) Deprecated. since 8.4, use (org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend.getLogEntriesFor(String, String)) instead.
List<LogEntry>	getLogEntriesFor(String uuid, String repositoryId) Returns the logs given a doc uuid and a repository id.
protected DocumentModel	guardedDocument(CoreSession session, DocumentRef reference)
protected DocumentModelList	guardedDocumentChildren(CoreSession session, DocumentRef reference)
protected boolean	isAuditable(EventBundle eventBundle)
void	logEvent(Event event) Logs an Event.
void	logEvents(EventBundle bundle) Logs a bundle of events
List<?>	nativeQuery(String query, int pageNb, int pageSize) Returns a batched list of entries.
List<LogEntry>	nativeQueryLogs(String whereClause, int pageNb, int pageSize) Returns a batched list of log entries.
abstract ExtendedInfo	newExtendedInfo(Serializable value) Create a new ExtendedInfo instance
LogEntry	newLogEntry() Create a new LogEntry instance.
protected void	populateExtendedInfo(LogEntry entry, DocumentModel source, ExpressionContext context, Collection<ExtendedInfoDescriptor> extInfos)
List<LogEntry>	queryLogs(String[] eventIds, String dateRange) Returns the list of log entries.
List<LogEntry>	queryLogsByPage(String[] eventIds, Date limit, String category, String path, int pageNb, int pageSize) Returns the batched list of log entries.
List<LogEntry>	queryLogsByPage(String[] eventIds, String dateRange, String category, String path, int pageNb, int pageSize) Returns the batched list of log entries.
protected long	syncLogCreationEntries(BaseLogEntryProvider provider, String repoId, String path, Boolean recurs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.audit.service.AuditBackend

getApplicationStartedOrder, onApplicationStarted, onShutdown

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditReader

getLogEntriesFor, getLogEntryByID, nativeQuery, queryLogsByPage, queryLogsByPage

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditLogger

addLogEntries

Methods inherited from interface org.nuxeo.ecm.platform.audit.api.AuditAdmin

getEventsCount, syncLogCreationEntries

Field Detail

log

protected static final org.apache.commons.logging.Log log

FORCE_AUDIT_FACET

public static final String FORCE_AUDIT_FACET

See Also:

Constant Field Values

component

protected final NXAuditEventsService component

config

protected final AuditBackendDescriptor config

expressionEvaluator

protected final ExpressionEvaluator expressionEvaluator

Constructor Detail

AbstractAuditBackend

protected AbstractAuditBackend(NXAuditEventsService component,
                               AuditBackendDescriptor config)

Method Detail

guardedDocument

protected DocumentModel guardedDocument(CoreSession session,
                                        DocumentRef reference)

guardedDocumentChildren

protected DocumentModelList guardedDocumentChildren(CoreSession session,
                                                    DocumentRef reference)

doCreateAndFillEntryFromDocument

protected LogEntry doCreateAndFillEntryFromDocument(DocumentModel doc,
                                                    Principal principal)

doPutExtendedInfos

protected void doPutExtendedInfos(LogEntry entry,
                                  EventContext eventContext,
                                  DocumentModel source,
                                  Principal principal)

populateExtendedInfo

protected void populateExtendedInfo(LogEntry entry,
                                    DocumentModel source,
                                    ExpressionContext context,
                                    Collection<ExtendedInfoDescriptor> extInfos)

Since:

7.4

getAuditableEventNames

public Set<String> getAuditableEventNames()

Description copied from interface: AuditLogger

Returns the list of auditable event names.

Specified by:

getAuditableEventNames in interface AuditLogger

Returns:

list of String representing event names.

buildEntryFromEvent

protected LogEntry buildEntryFromEvent(Event event)

queryLogsByPage

public List<LogEntry> queryLogsByPage(String[] eventIds,
                                      String dateRange,
                                      String category,
                                      String path,
                                      int pageNb,
                                      int pageSize)

Description copied from interface: AuditReader

Returns the batched list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Specified by:

queryLogsByPage in interface AuditReader

Parameters:

eventIds - the event ids.

dateRange - a preset date range.

category - add filter on events category

path - add filter on document path

pageNb - page number (ignore if <=1)

pageSize - number of results per page

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

queryLogsByPage

public List<LogEntry> queryLogsByPage(String[] eventIds,
                                      Date limit,
                                      String category,
                                      String path,
                                      int pageNb,
                                      int pageSize)

Description copied from interface: AuditReader

Returns the batched list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Specified by:

queryLogsByPage in interface AuditReader

Parameters:

eventIds - the event ids.

limit - filter events by date from limit to now

category - add filter on events category

path - add filter on document path

pageNb - page number (ignore if <=1)

pageSize - number of results per page

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

newLogEntry

public LogEntry newLogEntry()

Description copied from interface: AuditLogger

Create a new LogEntry instance.

Specified by:

newLogEntry in interface AuditLogger

Returns:

newExtendedInfo

public abstract ExtendedInfo newExtendedInfo(Serializable value)

Description copied from interface: AuditLogger

Create a new ExtendedInfo instance

Specified by:

newExtendedInfo in interface AuditLogger

Returns:

syncLogCreationEntries

protected long syncLogCreationEntries(BaseLogEntryProvider provider,
                                      String repoId,
                                      String path,
                                      Boolean recurs)

doSyncNode

protected long doSyncNode(BaseLogEntryProvider provider,
                          CoreSession session,
                          DocumentModel node,
                          boolean recurs)

logEvents

public void logEvents(EventBundle bundle)

Description copied from interface: AuditLogger

Logs a bundle of events

Specified by:

logEvents in interface AuditLogger

isAuditable

protected boolean isAuditable(EventBundle eventBundle)

logEvent

public void logEvent(Event event)

Description copied from interface: AuditLogger

Logs an Event.

Specified by:

logEvent in interface AuditLogger

await

public boolean await(long time,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

await in interface AuditLogger

Throws:

InterruptedException

getLogEntriesFor

public List<LogEntry> getLogEntriesFor(String uuid,
                                       String repositoryId)

Returns the logs given a doc uuid and a repository id.

Specified by:

getLogEntriesFor in interface AuditReader

Parameters:

uuid - the document uuid

repositoryId - the repository id

Returns:

a list of log entries

Since:

8.4

getLogEntriesFor

@Deprecated
public List<LogEntry> getLogEntriesFor(String uuid)

Deprecated. since 8.4, use (org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend.getLogEntriesFor(String, String)) instead.

Returns the logs given a doc uuid.

Specified by:

getLogEntriesFor in interface AuditReader

Parameters:

uuid - the document uuid

Returns:

a list of log entries

nativeQuery

public List<?> nativeQuery(String query,
                           int pageNb,
                           int pageSize)

Description copied from interface: AuditReader

Returns a batched list of entries. query string is a native query clause for the backend : here EJBQL 3.0 must be used if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch.

Specified by:

nativeQuery in interface AuditReader

queryLogs

public List<LogEntry> queryLogs(String[] eventIds,
                                String dateRange)

Description copied from interface: AuditReader

Returns the list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Specified by:

queryLogs in interface AuditReader

Parameters:

eventIds - the event ids.

dateRange - a preset date range.

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

nativeQueryLogs

public List<LogEntry> nativeQueryLogs(String whereClause,
                                      int pageNb,
                                      int pageSize)

Description copied from interface: AuditReader

Returns a batched list of log entries. WhereClause is a native where clause for the backend: here EJBQL 3.0 must be used if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch.

Specified by:

nativeQueryLogs in interface AuditReader