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

Contains the Hibernate based (legacy) implementation

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistenceProvider	persistenceProvider

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

component, config, expressionEvaluator, FORCE_AUDIT_FACET, log

Constructor Summary

Constructors

Constructor and Description
DefaultAuditBackend(NXAuditEventsService component, AuditBackendDescriptor config)

Method Summary

Modifier and Type	Method and Description
protected void	activatePersistenceProvider()
protected void	addLogEntries(javax.persistence.EntityManager em, List<LogEntry> entries)
void	addLogEntries(List<LogEntry> entries) Adds given log entries.
int	getApplicationStartedOrder()
Long	getEventsCount(javax.persistence.EntityManager em, String eventId)
Long	getEventsCount(String eventId)
protected List<LogEntry>	getLogEntriesFor(javax.persistence.EntityManager em, String uuid)
protected List<LogEntry>	getLogEntriesFor(javax.persistence.EntityManager em, String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort)
protected List<LogEntry>	getLogEntriesFor(javax.persistence.EntityManager em, String uuid, String repositoryId)
List<LogEntry>	getLogEntriesFor(String uuid) Returns the logs given a doc uuid.
List<LogEntry>	getLogEntriesFor(String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort) Returns the logs given a doc uuid, a map of filters and a default sort.
List<LogEntry>	getLogEntriesFor(String uuid, String repositoryId) Returns the logs given a doc uuid and a repository id.
protected LogEntry	getLogEntryByID(javax.persistence.EntityManager em, long id)
LogEntry	getLogEntryByID(long id) Returns a given log entry given its id.
List<String>	getLoggedEventIds()
protected List<String>	getLoggedEventIds(javax.persistence.EntityManager em)
PersistenceProvider	getOrCreatePersistenceProvider()
protected List<?>	nativeQuery(javax.persistence.EntityManager em, String query, int pageNb, int pageSize)
protected List<?>	nativeQuery(javax.persistence.EntityManager em, String query, Map<String,Object> params, int pageNb, int pageSize)
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.
protected List<LogEntry>	nativeQueryLogs(javax.persistence.EntityManager em, String whereClause, int pageNb, int pageSize)
List<LogEntry>	nativeQueryLogs(String whereClause, int pageNb, int pageSize) Returns a batched list of log entries.
ExtendedInfo	newExtendedInfo(Serializable value) Create a new ExtendedInfo instance
void	onApplicationStarted()
void	onShutdown()
protected List<LogEntry>	queryLogs(javax.persistence.EntityManager em, String[] eventIds, String dateRange)
List<LogEntry>	queryLogs(String[] eventIds, String dateRange) Returns the list of log entries.
protected List<LogEntry>	queryLogsByPage(javax.persistence.EntityManager em, String[] eventIds, Date limit, String[] category, String path, int pageNb, int pageSize)
protected List<LogEntry>	queryLogsByPage(javax.persistence.EntityManager em, String[] eventIds, Date limit, String category, String path, int pageNb, int pageSize)
protected List<LogEntry>	queryLogsByPage(javax.persistence.EntityManager em, String[] eventIds, String dateRange, String[] category, String path, int pageNb, int pageSize)
protected List<LogEntry>	queryLogsByPage(javax.persistence.EntityManager em, String[] eventIds, String dateRange, String category, String path, int pageNb, int pageSize)
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)
protected long	syncLogCreationEntries(javax.persistence.EntityManager em, String repoId, String path, Boolean recurs)
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

await, buildEntryFromEvent, doCreateAndFillEntryFromDocument, doPutExtendedInfos, doSyncNode, getAuditableEventNames, guardedDocument, guardedDocumentChildren, isAuditable, logEvent, logEvents, newLogEntry, populateExtendedInfo, queryLogsByPage, queryLogsByPage, syncLogCreationEntries

Methods inherited from class java.lang.Object

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

Field Detail

persistenceProvider

protected PersistenceProvider persistenceProvider

Constructor Detail

DefaultAuditBackend

public DefaultAuditBackend(NXAuditEventsService component,
                           AuditBackendDescriptor config)

Method Detail

getApplicationStartedOrder

public int getApplicationStartedOrder()

onApplicationStarted

public void onApplicationStarted()

onShutdown

public void onShutdown()

getOrCreatePersistenceProvider

public PersistenceProvider getOrCreatePersistenceProvider()

activatePersistenceProvider

protected void activatePersistenceProvider()

addLogEntries

public void addLogEntries(List<LogEntry> entries)

Description copied from interface: AuditLogger

Adds given log entries.

Parameters:

entries - the list of log entries.

addLogEntries

protected void addLogEntries(javax.persistence.EntityManager em,
                             List<LogEntry> entries)

getLogEntriesFor

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

Description copied from class: AbstractAuditBackend

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

Specified by:

getLogEntriesFor in interface AuditReader

Overrides:

getLogEntriesFor in class AbstractAuditBackend

Parameters:

uuid - the document uuid

repositoryId - the repository id

Returns:

a list of log entries

getLogEntriesFor

protected List<LogEntry> getLogEntriesFor(javax.persistence.EntityManager em,
                                          String uuid,
                                          String repositoryId)

getLogEntriesFor

public List<LogEntry> getLogEntriesFor(String uuid)

Description copied from class: AbstractAuditBackend

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

protected List<LogEntry> getLogEntriesFor(javax.persistence.EntityManager em,
                                          String uuid)

getLogEntriesFor

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

Description copied from interface: AuditReader

Returns the logs given a doc uuid, a map of filters and a default sort.

Parameters:

uuid - the document uuid

filterMap - the map of filters to apply

doDefaultSort - the default sort to set

Returns:

a list of log entries

getLogEntriesFor

protected List<LogEntry> getLogEntriesFor(javax.persistence.EntityManager em,
                                          String uuid,
                                          Map<String,FilterMapEntry> filterMap,
                                          boolean doDefaultSort)

getLogEntryByID

public LogEntry getLogEntryByID(long id)

Description copied from interface: AuditReader

Returns a given log entry given its id.

Parameters:

id - the log entry identifier

Returns:

a LogEntry instance

getLogEntryByID

protected LogEntry getLogEntryByID(javax.persistence.EntityManager em,
                                   long id)

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

Overrides:

nativeQueryLogs in class AbstractAuditBackend

nativeQueryLogs

protected List<LogEntry> nativeQueryLogs(javax.persistence.EntityManager em,
                                         String whereClause,
                                         int pageNb,
                                         int pageSize)

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

Overrides:

nativeQuery in class AbstractAuditBackend

nativeQuery

protected List<?> nativeQuery(javax.persistence.EntityManager em,
                              String query,
                              int pageNb,
                              int pageSize)

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.

Parameters:

query - a JPA query language query if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch

params - parameters for the query

pageNb - the page number (starts at 1)

pageSize - the number of results per page

nativeQuery

protected List<?> nativeQuery(javax.persistence.EntityManager em,
                              String query,
                              Map<String,Object> params,
                              int pageNb,
                              int pageSize)

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

queryLogs

protected List<LogEntry> queryLogs(javax.persistence.EntityManager em,
                                   String[] eventIds,
                                   String dateRange)

queryLogsByPage

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

queryLogsByPage

protected List<LogEntry> queryLogsByPage(javax.persistence.EntityManager em,
                                         String[] eventIds,
                                         String dateRange,
                                         String[] category,
                                         String path,
                                         int pageNb,
                                         int pageSize)

queryLogsByPage

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

queryLogsByPage

protected List<LogEntry> queryLogsByPage(javax.persistence.EntityManager em,
                                         String[] eventIds,
                                         Date limit,
                                         String[] category,
                                         String path,
                                         int pageNb,
                                         int pageSize)

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.

syncLogCreationEntries

protected long syncLogCreationEntries(javax.persistence.EntityManager em,
                                      String repoId,
                                      String path,
                                      Boolean recurs)

getEventsCount

public Long getEventsCount(String eventId)

getEventsCount

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

getLoggedEventIds

public List<String> getLoggedEventIds()

getLoggedEventIds

protected List<String> getLoggedEventIds(javax.persistence.EntityManager em)

queryLogsByPage

protected List<LogEntry> queryLogsByPage(javax.persistence.EntityManager em,
                                         String[] eventIds,
                                         String dateRange,
                                         String category,
                                         String path,
                                         int pageNb,
                                         int pageSize)

queryLogsByPage

protected List<LogEntry> queryLogsByPage(javax.persistence.EntityManager em,
                                         String[] eventIds,
                                         Date limit,
                                         String category,
                                         String path,
                                         int pageNb,
                                         int pageSize)

newExtendedInfo

public ExtendedInfo newExtendedInfo(Serializable value)

Description copied from interface: AuditLogger

Create a new ExtendedInfo instance

Specified by:

newExtendedInfo in interface AuditLogger

Specified by:

newExtendedInfo in class AbstractAuditBackend

Returns: