org.nuxeo.elasticsearch.audit

Class ESAuditBackend

java.lang.Object

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

org.nuxeo.elasticsearch.audit.ESAuditBackend

All Implemented Interfaces:

AuditAdmin, AuditLogger, AuditReader, Logs, AuditBackend

public class ESAuditBackend
extends AbstractAuditBackend
implements AuditBackend

Implementation of the AuditBackend interface using Elasticsearch persistence

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDX_NAME
static String	IDX_TYPE
static String	SEQ_NAME

Constructor Summary

Constructors

Constructor and Description
ESAuditBackend()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogEntries(List<LogEntry> entries) Adds given log entries.
org.elasticsearch.action.search.SearchRequestBuilder	buildQuery(String query, Map<String,Object> params)
org.elasticsearch.action.search.SearchRequestBuilder	buildSearchQuery(String fixedPart, PredicateDefinition[] predicates, DocumentModel searchDocumentModel)
void	deactivate()
String	expandQueryVariables(String query, Map<String,Object> params)
String	expandQueryVariables(String query, Object[] params)
Long	getEventsCount(String eventId)
List<LogEntry>	getLogEntriesFor(String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort)
LogEntry	getLogEntryByID(long id) Returns a given log entry given its id.
String	migrate(int batchSize)
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize) Returns a batched list of entries.
List<LogEntry>	queryLogsByPage(String[] eventIds, Date limit, String[] categories, String path, int pageNb, int pageSize)
List<LogEntry>	queryLogsByPage(String[] eventIds, String dateRange, String[] categories, 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, getLogEntriesFor, logEvent, logEvents, nativeQuery, nativeQueryLogs, newExtendedInfo, newLogEntry, queryLogs, 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

getLogEntriesFor, nativeQuery, nativeQueryLogs, queryLogs, queryLogsByPage, queryLogsByPage

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

getAuditableEventNames, logEvent, logEvents, newExtendedInfo, newLogEntry

Field Detail

IDX_NAME

public static final String IDX_NAME

See Also:

Constant Field Values

IDX_TYPE

public static final String IDX_TYPE

See Also:

Constant Field Values

SEQ_NAME

public static final String SEQ_NAME

See Also:

Constant Field Values

Constructor Detail

ESAuditBackend

public ESAuditBackend()

Method Detail

deactivate

public void deactivate()
                throws Exception

Specified by:

deactivate in interface AuditBackend

Throws:

Exception

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

buildQuery

public org.elasticsearch.action.search.SearchRequestBuilder buildQuery(String query,
                                                              Map<String,Object> params)

expandQueryVariables

public String expandQueryVariables(String query,
                          Object[] params)

expandQueryVariables

public String expandQueryVariables(String query,
                          Map<String,Object> params)

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

queryLogsByPage

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

Specified by:

queryLogsByPage in interface AuditReader

queryLogsByPage

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

Specified by:

queryLogsByPage in interface AuditReader

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.

getEventsCount

public Long getEventsCount(String eventId)

Specified by:

getEventsCount in interface AuditAdmin

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

buildSearchQuery

public org.elasticsearch.action.search.SearchRequestBuilder buildSearchQuery(String fixedPart,
                                                                    PredicateDefinition[] predicates,
                                                                    DocumentModel searchDocumentModel)

migrate

public String migrate(int batchSize)
               throws Exception

Throws:

Exception