org.nuxeo.drive.elasticsearch

Class ESAuditChangeFinder

java.lang.Object

org.nuxeo.drive.service.impl.AuditChangeFinder

org.nuxeo.drive.elasticsearch.ESAuditChangeFinder

All Implemented Interfaces:

Serializable, FileSystemChangeFinder

public class ESAuditChangeFinder
extends AuditChangeFinder

Override the JPA audit based change finder to execute query in ES.

The structure of the query executed by the AuditChangeFinder is:

 from LogEntry log where log.repositoryId = :repositoryId

 + AND if ActiveRoots (activeRoots) NOT empty

 from LogEntry log where log.repositoryId = :repositoryId and (
 LIST_DOC_EVENTS_IDS_QUERY and ( ROOT_PATHS or COLECTIONS_PATHS) or
 (log.category = 'NuxeoDrive' and log.eventId != 'rootUnregistered') )


 if ActiveRoots EMPTY:

 from LogEntry log where log.repositoryId = :repositoryId and ((log.category =
 'NuxeoDrive' and log.eventId != 'rootUnregistered'))

 + AND (log.id > :lowerBound and log.id <= :upperBound) + order by
 log.repositoryId asc, log.eventDate desc
 

Since:

7.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.elasticsearch.client.Client	esClient
static org.apache.commons.logging.Log	log

Fields inherited from class org.nuxeo.drive.service.impl.AuditChangeFinder

parameters

Constructor Summary

Constructors

Constructor and Description
ESAuditChangeFinder()

Method Summary

Modifier and Type	Method and Description
protected org.elasticsearch.index.query.QueryBuilder	buildFilterClauses(CoreSession session, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, boolean integerBounds, int limit)
protected org.elasticsearch.client.Client	getClient()
protected org.elasticsearch.index.query.TermsQueryBuilder	getCollectionSyncRootClause(Set<String> collectionSyncRootMemberIds)
protected org.elasticsearch.index.query.BoolQueryBuilder	getCurrentRootsClause(Set<String> rootPaths)
protected org.elasticsearch.index.query.BoolQueryBuilder	getDriveLogsQueryClause()
protected String	getESIndexName()
protected org.elasticsearch.index.query.BoolQueryBuilder	getEventsClause(String category, String[] eventIds, boolean shouldMatch)
protected org.elasticsearch.index.query.RangeQueryBuilder	getLogIdBoundsClause(long lowerBound, long upperBound)
long	getUpperBound() Return the last available log id in the audit log table (primary key) to be used as the upper bound of the event log id range clause in the change query.
long	getUpperBound(Set<String> repositoryNames) Returns the last available log id in the audit index considering events older than the last clustering invalidation date if clustering is enabled for at least one of the given repositories.
protected void	logSearchRequest(org.elasticsearch.action.search.SearchRequestBuilder request)
protected void	logSearchResponse(org.elasticsearch.action.search.SearchResponse response)
protected List<LogEntry>	queryAuditEntries(CoreSession session, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, boolean integerBounds, int limit)
protected List<LogEntry>	queryESAuditEntries(CoreSession session, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, boolean integerBounds, int limit)

Methods inherited from class org.nuxeo.drive.service.impl.AuditChangeFinder

getClusteringDelay, getCollectionSyncRootFilteringClause, getCurrentDate, getCurrentRootFilteringClause, getFileSystemChanges, getFileSystemChanges, getFileSystemChangesIntegerBounds, getFileSystemItemChange, getJPARangeClause, handleParameters

Methods inherited from class java.lang.Object

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

Field Detail

log

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

esClient

protected org.elasticsearch.client.Client esClient

Constructor Detail

ESAuditChangeFinder

public ESAuditChangeFinder()

Method Detail

queryESAuditEntries

protected List<LogEntry> queryESAuditEntries(CoreSession session,
                                             SynchronizationRoots activeRoots,
                                             Set<String> collectionSyncRootMemberIds,
                                             long lowerBound,
                                             long upperBound,
                                             boolean integerBounds,
                                             int limit)

buildFilterClauses

protected org.elasticsearch.index.query.QueryBuilder buildFilterClauses(CoreSession session,
                                                                        SynchronizationRoots activeRoots,
                                                                        Set<String> collectionSyncRootMemberIds,
                                                                        long lowerBound,
                                                                        long upperBound,
                                                                        boolean integerBounds,
                                                                        int limit)

getLogIdBoundsClause

protected org.elasticsearch.index.query.RangeQueryBuilder getLogIdBoundsClause(long lowerBound,
                                                                               long upperBound)

getCollectionSyncRootClause

protected org.elasticsearch.index.query.TermsQueryBuilder getCollectionSyncRootClause(Set<String> collectionSyncRootMemberIds)

getCurrentRootsClause

protected org.elasticsearch.index.query.BoolQueryBuilder getCurrentRootsClause(Set<String> rootPaths)

getDriveLogsQueryClause

protected org.elasticsearch.index.query.BoolQueryBuilder getDriveLogsQueryClause()

getEventsClause

protected org.elasticsearch.index.query.BoolQueryBuilder getEventsClause(String category,
                                                                         String[] eventIds,
                                                                         boolean shouldMatch)

getUpperBound

public long getUpperBound()

Description copied from class: AuditChangeFinder

Return the last available log id in the audit log table (primary key) to be used as the upper bound of the event log id range clause in the change query.

Specified by:

getUpperBound in interface FileSystemChangeFinder

Overrides:

getUpperBound in class AuditChangeFinder

getUpperBound

public long getUpperBound(Set<String> repositoryNames)

Returns the last available log id in the audit index considering events older than the last clustering invalidation date if clustering is enabled for at least one of the given repositories. This is to make sure the DocumentModel further fetched from the session using the audit entry doc id is fresh.

Specified by:

getUpperBound in interface FileSystemChangeFinder

Overrides:

getUpperBound in class AuditChangeFinder

queryAuditEntries

protected List<LogEntry> queryAuditEntries(CoreSession session,
                                           SynchronizationRoots activeRoots,
                                           Set<String> collectionSyncRootMemberIds,
                                           long lowerBound,
                                           long upperBound,
                                           boolean integerBounds,
                                           int limit)

Overrides:

queryAuditEntries in class AuditChangeFinder

getClient

protected org.elasticsearch.client.Client getClient()

getESIndexName

protected String getESIndexName()

logSearchRequest

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

logSearchResponse

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