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
static String	IDX_NAME
static String	IDX_TYPE
protected static org.apache.commons.logging.Log	log
protected BaseLogEntryProvider	provider
static String	SEQ_NAME

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

component, expressionEvaluator

Constructor Summary

Constructors

Constructor and Description
ESAuditBackend()

Method Summary

Modifier and Type	Method and Description
void	addLogEntries(List<LogEntry> entries)
protected org.elasticsearch.index.query.FilterBuilder	buildFilter(org.nuxeo.ecm.platform.query.api.PredicateDefinition[] predicates, DocumentModel searchDocumentModel)
org.elasticsearch.action.search.SearchRequestBuilder	buildQuery(String query, Map<String,Object> params)
org.elasticsearch.action.search.SearchRequestBuilder	buildSearchQuery(String fixedPart, org.nuxeo.ecm.platform.query.api.PredicateDefinition[] predicates, DocumentModel searchDocumentModel)
void	deactivate()
String	expandQueryVariables(String query, Map<String,Object> params)
String	expandQueryVariables(String query, Object[] params)
protected org.elasticsearch.client.Client	getClient()
Long	getEventsCount(String eventId)
List<LogEntry>	getLogEntriesFor(String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort)
LogEntry	getLogEntryByID(long id)
protected BaseLogEntryProvider	getProvider()
protected boolean	isNonNullParam(Object[] val)
String	migrate(int batchSize)
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize)
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)

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

activate, buildEntryFromEvent, doCreateAndFillEntryFromDocument, doPutExtendedInfos, doSyncNode, getAuditableEventNames, getLogEntriesFor, guardedDocument, guardedDocumentChildren, guardedPrincipal, guardedPrincipal, logEvent, logEvents, nativeQuery, nativeQueryLogs, newExtendedInfo, newLogEntry, 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

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

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

Method Detail

getClient

protected org.elasticsearch.client.Client getClient()

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)

Specified by:

getLogEntryByID in interface AuditReader

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)

Specified by:

nativeQuery in interface AuditReader

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)

Specified by:

addLogEntries in interface AuditLogger

getEventsCount

public Long getEventsCount(String eventId)

Specified by:

getEventsCount in interface AuditAdmin

getProvider

protected BaseLogEntryProvider getProvider()

syncLogCreationEntries

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

Specified by:

syncLogCreationEntries in interface AuditAdmin

buildFilter

protected org.elasticsearch.index.query.FilterBuilder buildFilter(org.nuxeo.ecm.platform.query.api.PredicateDefinition[] predicates,
                                                                  DocumentModel searchDocumentModel)

buildSearchQuery

public org.elasticsearch.action.search.SearchRequestBuilder buildSearchQuery(String fixedPart,
                                                                             org.nuxeo.ecm.platform.query.api.PredicateDefinition[] predicates,
                                                                             DocumentModel searchDocumentModel)

isNonNullParam

protected boolean isNonNullParam(Object[] val)

migrate

public String migrate(int batchSize)
               throws Exception

Throws:

Exception