org.nuxeo.ecm.platform.audit.service

Class DefaultAuditBackend

java.lang.Object

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

org.nuxeo.ecm.platform.audit.service.DefaultAuditBackend

All Implemented Interfaces:

AuditAdmin, AuditLogger, AuditReader, Logs, AuditBackend

public class DefaultAuditBackend
extends AbstractAuditBackend
implements AuditBackend

Contains the Hibernate based (legacy) implementation

Author:

tiry

Constructor Summary

Constructors

Constructor and Description
DefaultAuditBackend()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogEntries(List<LogEntry> entries) Adds given log entries.
void	addLogEntry(javax.persistence.EntityManager em, LogEntry entry)
void	addLogEntry(LogEntry entry)
void	deactivate()
Long	getEventsCount(javax.persistence.EntityManager em, String eventId)
Long	getEventsCount(String eventId)
List<LogEntry>	getLogEntriesFor(String uuid) Returns the logs given a doc uuid.
List<LogEntry>	getLogEntriesFor(String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort)
LogEntry	getLogEntryByID(long id) Returns a given log entry given its id.
List<String>	getLoggedEventIds()
PersistenceProvider	getOrCreatePersistenceProvider()
void	logEvent(Event event) Logs an Event.
void	logEvents(EventBundle eventBundle) Logs a bundle of events
List<?>	nativeQuery(String query, int pageNb, int pageSize) Returns a batched list of entries.
List<?>	nativeQuery(String query, Map<String,Object> params, 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.
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)
List<LogEntry>	queryLogsByPage(String[] eventIds, String dateRange, String[] category, String path, int pageNb, int pageSize)
long	syncLogCreationEntries(String repoId, String path, Boolean recurs) Forces log Synchronisation for a branch of the repository.

Methods inherited from class org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend

activate, getAuditableEventNames, newExtendedInfo, newLogEntry, queryLogsByPage, queryLogsByPage

Methods inherited from class java.lang.Object

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

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

activate

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

queryLogsByPage, queryLogsByPage

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

getAuditableEventNames, newExtendedInfo, newLogEntry

Constructor Detail

DefaultAuditBackend

public DefaultAuditBackend()

Method Detail

getOrCreatePersistenceProvider

public PersistenceProvider getOrCreatePersistenceProvider()

deactivate

public void deactivate()

Specified by:

deactivate in interface AuditBackend

addLogEntries

public void addLogEntries(List<LogEntry> entries)

Description copied from interface: AuditLogger

Adds given log entries.

Specified by:

addLogEntries in interface AuditLogger

Parameters:

entries - the list of log entries.

getLogEntriesFor

public List<LogEntry> getLogEntriesFor(String uuid)

Description copied from interface: AuditReader

Returns the logs given a doc uuid.

Specified by:

getLogEntriesFor in interface AuditReader

Overrides:

getLogEntriesFor in class AbstractAuditBackend

Parameters:

uuid - the document uuid

Returns:

a list of log entries

getLogEntriesFor

public List<LogEntry> getLogEntriesFor(String uuid,
                              Map<String,FilterMapEntry> filterMap,
                              boolean doDefaultSort)

Specified by:

getLogEntriesFor in interface AuditReader

getLogEntryByID

public LogEntry getLogEntryByID(long id)

Description copied from interface: AuditReader

Returns a given log entry given its id.

Specified by:

getLogEntryByID in interface AuditReader

Parameters:

id - the log entry identifier

Returns:

a LogEntry instance

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 can be used.

Specified by:

nativeQueryLogs in interface AuditReader

Overrides:

nativeQueryLogs in class AbstractAuditBackend

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 can be used

Specified by:

nativeQuery in interface AuditReader

Overrides:

nativeQuery in class AbstractAuditBackend

nativeQuery

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

Description copied from interface: AuditReader

Returns a batched list of entries.

Specified by:

nativeQuery in interface AuditReader

Parameters:

query - a JPA query language query

params - parameters for the query

pageNb - the page number (starts at 1)

pageSize - the number of results per page

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

Overrides:

queryLogs in class AbstractAuditBackend

Parameters:

eventIds - the event ids.

dateRange - a preset date range.

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

queryLogsByPage

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

Specified by:

queryLogsByPage in interface AuditReader

queryLogsByPage

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

Specified by:

queryLogsByPage in interface AuditReader

syncLogCreationEntries

public long syncLogCreationEntries(String repoId,
                          String path,
                          Boolean recurs)

Description copied from interface: AuditAdmin

Forces log Synchronisation for a branch of the repository. This can be useful to add the create entries if DB was initialized from a bulk import.

Specified by:

syncLogCreationEntries in interface AuditAdmin

addLogEntry

public void addLogEntry(LogEntry entry)

addLogEntry

public void addLogEntry(javax.persistence.EntityManager em,
               LogEntry entry)

getEventsCount

public Long getEventsCount(String eventId)

Specified by:

getEventsCount in interface AuditAdmin

getEventsCount

public Long getEventsCount(javax.persistence.EntityManager em,
                  String eventId)

getLoggedEventIds

public List<String> getLoggedEventIds()

logEvent

public void logEvent(Event event)

Description copied from interface: AuditLogger

Logs an Event.

Specified by:

logEvent in interface AuditLogger

Overrides:

logEvent in class AbstractAuditBackend

logEvents

public void logEvents(EventBundle eventBundle)

Description copied from interface: AuditLogger

Logs a bundle of events

Specified by:

logEvents in interface AuditLogger

Overrides:

logEvents in class AbstractAuditBackend