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
protected org.elasticsearch.client.Client	esClient
protected static org.apache.commons.logging.Log	log
static String	MIGRATION_BATCH_SIZE_PROP
static int	MIGRATION_DEFAULT_BACTH_SIZE
static String	MIGRATION_DONE_EVENT
static String	MIGRATION_FLAG_PROP
protected BaseLogEntryProvider	provider
static String	SEQ_NAME

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

component, config, expressionEvaluator, FORCE_AUDIT_FACET

Constructor Summary

Constructors

Constructor and Description
ESAuditBackend(NXAuditEventsService component, AuditBackendDescriptor config)

Method Summary

Modifier and Type	Method and Description
void	addLogEntries(List<LogEntry> entries) Adds given log entries.
protected org.elasticsearch.index.query.QueryBuilder	buildFilter(PredicateDefinition[] predicates, DocumentModel searchDocumentModel)
protected List<LogEntry>	buildLogEntries(org.elasticsearch.action.search.SearchResponse searchResponse)
org.elasticsearch.action.search.SearchRequestBuilder	buildQuery(String query, Map<String,Object> params)
org.elasticsearch.action.search.SearchRequestBuilder	buildSearchQuery(String fixedPart, PredicateDefinition[] predicates, DocumentModel searchDocumentModel)
protected void	ensureUIDSequencer(org.elasticsearch.client.Client esClient) Ensures the audit sequence returns an UID greater or equal than the maximum log entry id.
String	expandQueryVariables(String query, Map<String,Object> params)
String	expandQueryVariables(String query, Object[] params)
int	getApplicationStartedOrder()
protected org.elasticsearch.client.Client	getClient()
protected String	getESIndexName()
Long	getEventsCount(String eventId)
protected List<LogEntry>	getLogEntries(org.elasticsearch.index.query.QueryBuilder filter, boolean doDefaultSort)
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.
LogEntry	getLogEntryByID(long id) Returns a given log entry given its id.
protected org.elasticsearch.action.search.SearchRequestBuilder	getSearchRequestBuilder(org.elasticsearch.client.Client esClient)
protected boolean	isMigrationDone()
protected boolean	isNonNullParam(Object[] val)
protected void	logSearchRequest(org.elasticsearch.action.search.SearchRequestBuilder request)
protected void	logSearchResponse(org.elasticsearch.action.search.SearchResponse response)
String	migrate(int batchSize)
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize) Returns a batched list of entries.
ExtendedInfo	newExtendedInfo(Serializable value) Create a new ExtendedInfo instance
void	onApplicationStarted()
void	onApplicationStopped()
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

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

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

onShutdown

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

await, getAuditableEventNames, logEvent, logEvents, newLogEntry

Field Detail

SEQ_NAME

public static final String SEQ_NAME

See Also:

Constant Field Values

MIGRATION_FLAG_PROP

public static final String MIGRATION_FLAG_PROP

See Also:

Constant Field Values

MIGRATION_BATCH_SIZE_PROP

public static final String MIGRATION_BATCH_SIZE_PROP

See Also:

Constant Field Values

MIGRATION_DONE_EVENT

public static final String MIGRATION_DONE_EVENT

See Also:

Constant Field Values

MIGRATION_DEFAULT_BACTH_SIZE

public static final int MIGRATION_DEFAULT_BACTH_SIZE

See Also:

Constant Field Values

esClient

protected org.elasticsearch.client.Client esClient

log

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

provider

protected BaseLogEntryProvider provider

Constructor Detail

ESAuditBackend

public ESAuditBackend(NXAuditEventsService component,
                      AuditBackendDescriptor config)

Method Detail

getClient

protected org.elasticsearch.client.Client getClient()

isMigrationDone

protected boolean isMigrationDone()

getApplicationStartedOrder

public int getApplicationStartedOrder()

Specified by:

getApplicationStartedOrder in interface AuditBackend

onApplicationStarted

public void onApplicationStarted()

Specified by:

onApplicationStarted in interface AuditBackend

onApplicationStopped

public void onApplicationStopped()

Specified by:

onApplicationStopped in interface AuditBackend

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

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.

Specified by:

getLogEntriesFor in interface AuditReader

Parameters:

uuid - the document uuid

filterMap - the map of filters to apply

doDefaultSort - the default sort to set

Returns:

a list of log entries

getLogEntries

protected List<LogEntry> getLogEntries(org.elasticsearch.index.query.QueryBuilder filter,
                                       boolean doDefaultSort)

buildLogEntries

protected List<LogEntry> buildLogEntries(org.elasticsearch.action.search.SearchResponse searchResponse)

getSearchRequestBuilder

protected org.elasticsearch.action.search.SearchRequestBuilder getSearchRequestBuilder(org.elasticsearch.client.Client esClient)

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 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

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

buildFilter

protected org.elasticsearch.index.query.QueryBuilder buildFilter(PredicateDefinition[] predicates,
                                                                 DocumentModel searchDocumentModel)

buildSearchQuery

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

isNonNullParam

protected boolean isNonNullParam(Object[] val)

migrate

public String migrate(int batchSize)

logSearchResponse

protected void logSearchResponse(org.elasticsearch.action.search.SearchResponse response)

logSearchRequest

protected void logSearchRequest(org.elasticsearch.action.search.SearchRequestBuilder request)

ensureUIDSequencer

protected void ensureUIDSequencer(org.elasticsearch.client.Client esClient)

Ensures the audit sequence returns an UID greater or equal than the maximum log entry id.

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:

getESIndexName

protected String getESIndexName()